Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Implements

Index

Constructors

constructor

Properties

Protected activePointerEvents

activePointerEvents: Map<number, ModifierMouseArgs> = new Map()

Stores info about active pointerdown events

allowClickSelect

allowClickSelect: boolean

When true, allow single click to select a data-point. Also see allowDragSelect for the option to drag to select multiple points

remarks

Default value is TRUE

allowDragSelect

allowDragSelect: boolean

When true, allow dragging a rectangle to select multiple data-points. Also see allowClickSelect for the option to click to select a single point

remarks

Default value is TRUE

Protected changedPropertiesList

changedPropertiesList: string[] = []

Protected executeOnProperty

executeOnProperty: EExecuteOn = EExecuteOn.MouseLeftButton

Readonly id

id: string

A unique Id for the IChartModifierBase

invalidateParentCallback

invalidateParentCallback: () => void

A callback to invalidate the parent SciChartSurfaceBase

Type declaration

    • (): void
    • Returns void

Protected isAttachedProperty

isAttachedProperty: boolean

Protected isEnabledProperty

isEnabledProperty: boolean = true

modifierGroup

modifierGroup: string | undefined

Specifies a string ID to group modifiers.

remarks

When one receives a mouse event, all modifiers in the same group receive the event.

Protected mousePoint

mousePoint: Point | undefined

Protected parentSurfaceProperty

parentSurfaceProperty: SciChartSurface

Protected previousPoint

previousPoint: Point | undefined

Protected receiveHandledEventsProperty

receiveHandledEventsProperty: boolean

Readonly selectionChanged

selectionChanged: EventHandler<DataPointSelectionChangedArgs> = new EventHandler<DataPointSelectionChangedArgs>()

A selection-changed EventHandler. See EventHandler for how to subscribe to and be notified when any Series is selected or unselected

Readonly type

type: DataPointSelection = EChart2DModifierType.DataPointSelection

Protected typeMap

typeMap: Map<string, string> = new Map<string, string>()

Protected xAxisIdProperty

xAxisIdProperty: string = AxisCore.DEFAULT_AXIS_ID

xyDirection

xyDirection: EXyDirection = EXyDirection.XyDirection

Protected yAxisIdProperty

yAxisIdProperty: string = AxisCore.DEFAULT_AXIS_ID

Accessors

canReceiveMouseEvents

  • get canReceiveMouseEvents(): boolean

executeOn

  • The operation that modifier should respond to

    inheritdoc

    Returns EExecuteOn

  • The operation that modifier should respond to

    inheritdoc

    Parameters

    Returns void

includedSeries

  • Used internally for tests. Gets a Map of included series

    remarks

    Series include flag set to false means excluded. Series not present or flag=true means included

    Returns Map<IRenderableSeries, boolean>

isAttached

  • get isAttached(): boolean

isEnabled

  • get isEnabled(): boolean
  • set isEnabled(isEnabled: boolean): void
  • When true, the modifier is enabled

    inheritdoc

    Returns boolean

  • When true, the modifier is enabled

    inheritdoc

    Parameters

    • isEnabled: boolean

    Returns void

modifierType

parentSurface

receiveHandledEvents

  • get receiveHandledEvents(): boolean
  • set receiveHandledEvents(receiveHandledEvents: boolean): void
  • When true, this modifier should receive events which have been handled by modifiers higher up in the call hierachy.

    inheritdoc

    Returns boolean

  • When true, this modifier should receive events which have been handled by modifiers higher up in the call hierachy.

    inheritdoc

    Parameters

    • receiveHandledEvents: boolean

    Returns void

selectedDataPoints

  • An array of currently selected series which can be observed by subscribing to the selectionChanged event handler

    remarks

    See documentation for how to subscribe to changes

    Returns DataPointInfo[]

selectionFill

  • get selectionFill(): string
  • set selectionFill(selectionFill: string): void
  • Gets or sets the fill of the selection rect when the user drags on the chart

    Returns string

  • Gets or sets the fill of the selection rect when the user drags on the chart

    Parameters

    • selectionFill: string

    Returns void

selectionStroke

  • get selectionStroke(): string
  • set selectionStroke(selectionStroke: string): void
  • Gets or sets the stroke of the selection rect when the user drags on the chart

    Returns string

  • Gets or sets the stroke of the selection rect when the user drags on the chart

    Parameters

    • selectionStroke: string

    Returns void

selectionStrokeThickness

  • get selectionStrokeThickness(): number
  • set selectionStrokeThickness(selectionStrokeThickness: number): void
  • Gets or sets the strokeThickness of the selection rect when the user drags on the chart

    Returns number

  • Gets or sets the strokeThickness of the selection rect when the user drags on the chart

    Parameters

    • selectionStrokeThickness: number

    Returns void

xAxisId

  • get xAxisId(): string
  • set xAxisId(xAxisId: string): void
  • inheritdoc

    Returns string

  • inheritdoc

    Parameters

    • xAxisId: string

    Returns void

yAxisId

  • get yAxisId(): string
  • set yAxisId(yAxisId: string): void
  • inheritdoc

    Returns string

  • inheritdoc

    Parameters

    • yAxisId: string

    Returns void

Methods

applyTheme

delete

  • delete(): void

Protected deselectAllPoints

  • deselectAllPoints(invalidate?: boolean): void
  • Deselects all points

    Parameters

    Returns void

Protected getAllSeries

getIncludedRenderableSeries

Protected getIsActionAllowed

Protected getSelectionMode

Protected growBy

  • Grows the Axis by a fraction around the mouse point

    Parameters

    • mousePoint: Point

      the X,Y location of the mouse at the time of the operation

    • axis: AxisBase2D

      the Axis to grow or shrink

    • fraction: number

      the fraction, e.g. 0.1 grows the axis by 10%

    Returns void

includeSeries

modifierDoubleClick

modifierDrop

modifierMouseDown

modifierMouseEnter

modifierMouseLeave

modifierMouseMove

modifierMouseUp

modifierMouseWheel

modifierPointerCancel

Protected notifyPropertyChanged

  • notifyPropertyChanged(propertyName: string): void

onAttach

  • onAttach(): void

onAttachSeries

onAttachSubSurface

onDetach

  • onDetach(): void

onDetachSeries

onDetachSubSurface

onParentSurfaceRendered

  • onParentSurfaceRendered(): void

Protected selectManyPoints

  • Selects all points inside the Rect, according to the ESelectionMode passed in

    Parameters

    Returns void

Protected selectSinglePoint

  • Performs selection of a single point with the desired ESelectionMode

    Parameters

    Returns void

setParentSurface

Protected testPropertyChanged

  • testPropertyChanged(propertyName: string): boolean

toJSON

  • toJSON(): { options: {}; type: string }

Protected updatePointerInfo

Generated using TypeDoc