Options
All
  • Public
  • Public/Protected
  • All
Menu

The OverviewRangeSelectionModifier provides drag-rectangle to zoom behavior on a 2D SciChartSurface within SciChart - High Performance JavaScript Charts

remarks

To apply the OverviewRangeSelectionModifier to a SciChartSurface and add drag to zoom behavior, use the following code:

const sciChartSurface: SciChartSurface;
sciChartSurface.chartModifiers.add(new OverviewRangeSelectionModifier());

Hierarchy

Implements

Index

Constructors

constructor

Properties

animate

animate: boolean = true

animationDuration

animationDuration: number = 1000

Protected annotationAfterSelectedAreaProperty

annotationAfterSelectedAreaProperty: OverviewCustomResizableAnnotation

Protected annotationBeforeSelectedAreaProperty

annotationBeforeSelectedAreaProperty: OverviewCustomResizableAnnotation

Protected changedPropertiesList

changedPropertiesList: string[] = []

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 isClicked

isClicked: boolean = false

Protected isEnabledProperty

isEnabledProperty: boolean = true

modifierGroup

modifierGroup: string

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

onSelectedAreaChanged

onSelectedAreaChanged: (area?: NumberRange) => void

Type declaration

overviewPositionAnimation

overviewPositionAnimation: IGenericAnimation

Protected pointTo

pointTo: Point

Protected rangeSelectionAnnotationProperty

rangeSelectionAnnotationProperty: OverviewCustomResizableAnnotation

Protected receiveHandledEventsProperty

receiveHandledEventsProperty: boolean

Readonly type

type: OverviewRangeSelection = EChart2DModifierType.OverviewRangeSelection

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

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

rangeSelectionAnnotation

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

selectedArea

  • Gets or sets the selected area ranges of the modifier

    Returns NumberRange

  • Gets or sets the selected area ranges of the modifier

    Parameters

    Returns void

unselectedsvgString

  • get unselectedsvgString(): string
  • set unselectedsvgString(svgString: string): void
  • Gets the svg string for the unselected part of the range

    Returns string

  • Sets the svg string for the unselected part of the range

    Parameters

    • svgString: string

    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
  • 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

Protected getAllSeries

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

modifierDoubleClick

modifierMouseDown

modifierMouseEnter

modifierMouseLeave

modifierMouseMove

modifierMouseUp

modifierMouseWheel

modifierPointerCancel

Protected notifyPropertyChanged

  • notifyPropertyChanged(propertyName: string): void

onAttach

  • onAttach(): void

onAttachSeries

onDetach

  • onDetach(): void

onDetachSeries

onParentSurfaceRendered

  • onParentSurfaceRendered(): void

setParentSurface

Protected testPropertyChanged

  • testPropertyChanged(propertyName: string): boolean

toJSON

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

Protected updateSelectionAnnotation

  • updateSelectionAnnotation(): void
  • Returns void

Generated using TypeDoc