ChartIQSignal

public class ChartIQSignal : NSObject

Encapsulates parameters with additional information for Signal.

Public Properties

  • The ChartIQSignal study parameter.

    Declaration

    Swift

    public var study: ChartIQStudy

  • The ChartIQSignal conditions parameter. Array of conditions. Each condition is itself an array of [leftIndicator, operator, rightIndicator, color, markerOptions]

    Declaration

    Swift

    public var conditions: [ChartIQCondition]

  • The ChartIQSignal joiner parameter. & or | to join conditions. If omitted, “|” assumed.

    Declaration

    Swift

    public var joiner: ChartIQSignalJoiner

  • The ChartIQSignal name parameter. Name of Signal. Signal will be saved with this name and this name will appear in any study legend and in the expanded signal’s title.

    Declaration

    Swift

    public var name: String

  • The ChartIQSignal description parameter. Description of signal. Can be nil.

    Declaration

    Swift

    public var signalDescription: String?

  • The ChartIQSignal isEnabled parameter.

    Declaration

    Swift

    public var isEnabled: Bool

Initializers

  • Init Signal model with all parameters.

    Declaration

    Swift

    public init(study: ChartIQStudy,
            conditions: [ChartIQCondition],
            joiner: ChartIQSignalJoiner,
            name: String,
            signalDescription: String? = nil,
            isEnabled: Bool = false)

    Parameters

    study

    The ChartIQStudy model.
    conditions

    The Array of ChartIQCondition models.
    joiner

    The ChartIQSignalJoiner model.
    name

    The String Object.
    signalDescription

    The String Object. Can be nil.
    isEnabled

    The Bool Object.

  • Init Signal model with dictionary.

    Declaration

    Swift

    public init?(dictionary: [String : Any])

    Parameters

    dictionary

    The dictionary with data for init Signal model.

Helpers

  • Convert Signal model to dictionary.

    Declaration

    Swift

    public func toDictionary() -> [String : Any]

    Return Value

    The dictionary with Signal model parameters.

  • Convert Signal model to JSON string.

    Declaration

    Swift

    public func toJSONString() -> String

    Return Value

    The JSON string with Signal model parameters.