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

Protected executeOnProperty

executeOnProperty: EExecuteOn = EExecuteOn.MouseLeftButton

Readonly id

id: string

A unique Id for the IChartModifierBase

Protected includedSeriesMap

includedSeriesMap: Map<IRenderableSeries3D, boolean> = new Map<IRenderableSeries3D, boolean>()

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

Protected receiveHandledEventsProperty

receiveHandledEventsProperty: boolean

showTooltip

showTooltip: boolean = true

Gets or sets whether we should display the tooltip. Default is true

Protected tooltipAnnotation

tooltipAnnotation: TooltipSvgAnnotation3D

Optional tooltipTitle

tooltipTitle: string

Readonly type

type: Tooltip = EChart3DModifierType.Tooltip
inheritdoc

Protected typeMap

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

Accessors

canReceiveMouseEvents

  • get canReceiveMouseEvents(): boolean

crosshairStroke

  • get crosshairStroke(): string
  • set crosshairStroke(stroke: string): void
  • Gets or sets the stroke color of the crosshair as an HTML Color code

    Returns string

  • Gets or sets the stroke color of the crosshair as an HTML Color code

    Parameters

    • stroke: string

    Returns void

crosshairStrokeThickness

  • get crosshairStrokeThickness(): number
  • set crosshairStrokeThickness(strokeThickness: number): void
  • Gets or sets the strokethickness of the crosshair line

    Returns number

  • Gets or sets the strokethickness of the crosshair line

    Parameters

    • strokeThickness: number

    Returns void

executeOn

  • The operation that modifier should respond to

    inheritdoc

    Returns EExecuteOn

  • The operation that modifier should respond to

    inheritdoc

    Parameters

    Returns void

isAttached

  • get isAttached(): boolean

isCrosshairVisible

  • get isCrosshairVisible(): boolean
  • set isCrosshairVisible(isVisible: boolean): void
  • When true, a crosshair line will be displayed from the hovered point location to the far axis wall

    Returns boolean

  • When true, a crosshair line will be displayed from the hovered point location to the far axis wall

    Parameters

    • isVisible: boolean

    Returns void

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

placementDivId

  • get placementDivId(): string
  • set placementDivId(value: string): void
  • Gets or sets the parent div element reference or id for the Tooltip

    Returns string

  • Gets or sets the parent div element reference or id for the Tooltip

    Parameters

    • value: string

    Returns void

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

tooltipContainerBackground

  • get tooltipContainerBackground(): string
  • set tooltipContainerBackground(value: string): void
  • Returns string

  • Parameters

    • value: string

    Returns void

tooltipDataTemplate

tooltipLegendOffsetX

  • get tooltipLegendOffsetX(): number
  • set tooltipLegendOffsetX(value: number): void
  • Returns number

  • Parameters

    • value: number

    Returns void

tooltipLegendOffsetY

  • get tooltipLegendOffsetY(): number
  • set tooltipLegendOffsetY(value: number): void
  • Returns number

  • Parameters

    • value: number

    Returns void

tooltipLegendTemplate

tooltipSvgTemplate

tooltipTextStroke

  • get tooltipTextStroke(): string
  • set tooltipTextStroke(value: string): void
  • Returns string

  • Parameters

    • value: string

    Returns void

Methods

applyTheme

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

getIncludedSeries

Protected getIsActionAllowed

includeSeries

  • Parameters

    Returns void

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

setParentSurface

toJSON

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

Protected update

  • update(): void
  • Returns void

Protected updatePointerInfo

Generated using TypeDoc