iOS & macOS Charting Documentation - SciChart iOS & macOS Charts SDK v4.x

SCIModifierEventArgs

@interface SCIModifierEventArgs : NSObject <ISCICleanable>

Defines an event args, used by various classes within SciChart to process motion events.

  • Source of the event.

    Declaration

    Objective-C

    @property (nonatomic, weak, readwrite) id source;

    Swift

    weak var source: AnyObject! { get set }
  • Returns the location at which the associated gesture occurred.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite) CGPoint location;

    Swift

    var location: CGPoint { get set }
  • Gets number of pointers which used to generate this ISCIEvent.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
        NSUInteger pointersCount;

    Swift

    var pointersCount: UInt { get set }
  • A bit mask of the button (or buttons) recognized during the event.

    Declaration

    Objective-C

    @property (nonatomic, readonly) SCIButtonMask buttonMask;

    Swift

    var buttonMask: SCIButtonMask { get }
  • If YES - then this event occurred on a master ISCIPublishEvents.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite) BOOL isMaster;

    Swift

    var isMaster: Bool { get set }
  • If YES - then this event occurred inside the master ISCIPublishEvents.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
        BOOL isInSourceBounds;

    Swift

    var isInSourceBounds: Bool { get set }
  • Gets or sets whether this event is Handled.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite) BOOL isHandled;

    Swift

    var isHandled: Bool { get set }
  • Updates current event args, with passed in new args.

    Declaration

    Objective-C

    - (void)updateWithArgs:(SCIModifierEventArgs *)args;

    Swift

    func update(with args: SCIModifierEventArgs!)

    Parameters

    args

    Arguments to update current instantce of SCIModifierEventArgs with.