Options
All
  • Public
  • Public/Protected
  • All
Menu

The SeriesSelectionModifier3D provides series selection and hover behavior on a 3D SciChart3DSurface

Hierarchy

Implements

Index

Constructors

constructor

Properties

Protected activePointerEvents

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

Stores info about active pointerdown events

enableHover

enableHover: boolean

When true, hover is enabled. Any series under the mouse or pointer on mouseMove will be notified as mouseOver. Default false

enableSelection

enableSelection: boolean

When true, Selection is enabled. Any series under the mouse or pointer device on mouseUp can be selected. Default true

Readonly hitTestRadius

hitTestRadius: number

Readonly hoverChanged

hoverChanged: EventHandler<HoveredChangedArgs3D> = new EventHandler<HoveredChangedArgs3D>()

A hover-changed EventHandler. This is raised whenever any included series is hovered or unhovered.

hoveredSeries

hoveredSeries: IRenderableSeries3D[] = []

An array of currently hovered series which can be observed by subscribing to the hoverChanged event handler

Readonly id

id: string

A unique Id for the IChartModifierBase

includedSeries

includedSeries: IncludedItems = new IncludedItems()

The helper property to get and set the list of included renderable series

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: SciChart3DSurface

Protected previousPoint

previousPoint: Point | undefined

Readonly prioritizeClosestToCamera

prioritizeClosestToCamera: boolean

Protected receiveHandledEventsProperty

receiveHandledEventsProperty: boolean

Protected secondaryExecuteConditionProperty

secondaryExecuteConditionProperty: TModifierExecuteCondition | undefined

selectedSeries

selectedSeries: IRenderableSeries3D[] = []

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

Readonly selectionChanged

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

A selection-changed EventHandler. This is raised whenever any included series is selected or unselected.

Readonly type

type: EChart3DModifierType = EChart3DModifierType.SeriesSelection

Protected typeMap

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

Accessors

canReceiveMouseEvents

  • get canReceiveMouseEvents(): boolean
  • When true, this modifier can receive mouse events

    inheritdoc

    Returns boolean

executeCondition

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

secondaryExecuteCondition

Methods

applyTheme

checkExecuteCondition

checkExecuteConditions

  • checkExecuteConditions(args: ModifierMouseArgs): { isPrimary: boolean | undefined; isSecondary: boolean | undefined }
  • Checks execute primary and secondary conditions

    Parameters

    Returns { isPrimary: boolean | undefined; isSecondary: boolean | undefined }

    • isPrimary: boolean | undefined
    • isSecondary: boolean | undefined

delete

  • delete(): void
  • Deletes native (WebAssembly) memory used by this type, after which it cannot be used.

    remarks

    Call .delete() before finishing with the object to ensure that WebAssmembly memory leaks do not occur.

    All elements within SciChart's High Performance Realtime JavaScript Charts which implement IDeletable must be deleted manually to free native (WebAssembly) memory

    Returns void

getAllSeries

getIncludedRenderableSeries

  • Returns all visible and included renderable series. The list also contains included visible stacked renderable series This calls this.testIsIncludedSeries so it is best to customise the including check behaviour there.

    Returns IRenderableSeries3D[]

Protected getIsActionAllowed

includeSeries

  • Includes renderable series. Returns True if the included items list has changed after the operation.

    Parameters

    Returns boolean

modifierDoubleClick

modifierDrop

modifierMouseDown

modifierMouseEnter

modifierMouseLeave

modifierMouseMove

modifierMouseUp

modifierMouseWheel

modifierPointerCancel

Protected notifyPropertyChanged

  • notifyPropertyChanged(propertyName: string): void

onAttach

  • onAttach(): void

onAttachSeries

  • onAttachSeries(rs: any): void
  • inheritdoc

    Parameters

    • rs: any

    Returns void

onAttachSubSurface

onDetach

  • onDetach(): void

onDetachSeries

  • onDetachSeries(rs: any): void
  • inheritdoc

    Parameters

    • rs: any

    Returns void

onDetachSubSurface

onParentSurfaceLayoutComplete

  • onParentSurfaceLayoutComplete(): void

onParentSurfaceRendered

  • onParentSurfaceRendered(): void

setParentSurface

toJSON

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

Protected updatePointerInfo

Object literals

Protected executeConditionProperty

executeConditionProperty: object

button

button: MouseLeftButton = EExecuteOn.MouseLeftButton

Generated using TypeDoc