Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • IChartModifierBaseOptions
    • IAnnotationEraserModifierOptions

Index

Properties

Optional dragStartThresholdPx

dragStartThresholdPx: number

Minimum movement before a drag becomes a stroke. Default 3.

Optional eraseAllAtHitPoint

eraseAllAtHitPoint: boolean

When true, removes every annotation hit at a point. When false, removes only the top-most hit annotation. Default false.

Optional eraserTrailColor

eraserTrailColor: string

Trail stroke color. Default "#808080".

Optional eraserTrailDisappearDelayMs

eraserTrailDisappearDelayMs: number

Delay before a completed trail is removed. Default 1500.

Optional eraserTrailOpacity

eraserTrailOpacity: number

Trail opacity. Default 0.45.

Optional eraserTrailStrokeThickness

eraserTrailStrokeThickness: number

Trail stroke thickness in CSS pixels. Default 15.

Optional eraserTrailWindowPx

eraserTrailWindowPx: number

Visible trail length in CSS pixels while dragging. Default 160.

Optional excludedSeriesIds

excludedSeriesIds: string[]

A list of renderable series to exclude from this modifier

remarks

Also see {@link ChartModifierBase2D.includedSeries} which has methods to include or exclude a series by instance

Optional excludedXAxisIds

excludedXAxisIds: string[]

A list of X axes to exclude from this modifier

remarks

Also see {@link ChartModifierBase2D.includedXAxes} which has methods to include or exclude an axis by instance

Optional excludedYAxisIds

excludedYAxisIds: string[]

A list of Y axes to exclude from this modifier

remarks

Also see {@link ChartModifierBase2D.includedYAxes} which has methods to include or exclude an axis by instance

Optional executeCondition

executeCondition: TModifierExecuteCondition

The primary action execute condition that modifier should respond to

Optional id

id: string

A unique Id for the {@link ChartModifierBase2D}

Optional includedSeriesIds

includedSeriesIds: string[]

A list of renderable series to include to this modifier

remarks

Also see {@link ChartModifierBase2D.includedSeries} which has methods to include or exclude a series by instance

Optional includedXAxisIds

includedXAxisIds: string[]

A list of X axes to include to this modifier

remarks

Also see {@link ChartModifierBase2D.includedXAxes} which has methods to include or exclude an axis by instance

Optional includedYAxisIds

includedYAxisIds: string[]

A list of Y axes to include this modifier

remarks

Also see {@link ChartModifierBase2D.includedYAxes} which has methods to include or exclude an axis by instance

Optional isErasing

isErasing: boolean

Starts modifier in active erasing mode. Default false.

Optional keepErasingAfterComplete

keepErasingAfterComplete: boolean

When true, the modifier remains active after a click or completed stroke. Default false.

Optional maxPoints

maxPoints: number

Maximum number of points captured in one stroke. Values <= 0 disable the cap. Default 6000.

Optional modifierGroup

modifierGroup: string

Defines the Modifier Group string - a grouping by ID for sharing mouse events across charts

Optional onAnnotationsErased

onAnnotationsErased: (args: IAnnotationsErasedArgs) => void

Callback raised after an erase hit removes one or more annotations.

Type declaration

Optional pointSamplingDistancePx

pointSamplingDistancePx: number

Minimum movement before another sample is added to the trail. Default 2.

Optional secondaryExecuteCondition

secondaryExecuteCondition: TModifierExecuteCondition

The secondary action execute condition that modifier should respond to

Optional showEraserTrail

showEraserTrail: boolean

When true, drag erasing shows a temporary freehand trail. Default true.

Optional strokeCursor

strokeCursor: ECursorStyle | string

Cursor shown while dragging a stroke. Default grabbing.

Optional targetFilter

targetFilter: (annotation: IAnnotation) => boolean

Optional predicate used to restrict which annotations can be erased.

Type declaration

    • (annotation: IAnnotation): boolean
    • Parameters

      • annotation: IAnnotation

      Returns boolean

Optional xAxisId

xAxisId: string

The XAxis Id to be used by annotations internal to the modifier. Set if you have multiple x axes and need to distinguish between horizontal/vertical, or stacked axes

Optional xyDirection

xyDirection: EXyDirection

Defines the {@link EXyDirection | Xy Direction} - whether the modifier works in X, Y or XY or neither direction, for vertical charts the behaviour could be inverted, for example for vertical chart with {@link RubberBandXyZoomModifier} and {@link EXyDirection.XDirection} the modifier works on Y axis

Optional yAxisId

yAxisId: string

The YAxis Id to be used by annotations internal to the modifier. Set if you have multiple y axes and need the modifier to use something other than the first one.

Generated using TypeDoc