Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Optional adornerClipping

adornerClipping: EAnnotationClippingMode | string

What to clip the adorner to. Defaults to SeriesViewRect for multi-point annotations.

Optional adornerVisibility

adornerVisibility: EAnnotationVisibilityMode

Visibility policy for the selection outline / adorner.

Optional allowMove

allowMove: boolean

Enables dragging the entire drawing body.

Default true

Optional axisLabelCornerRadius

axisLabelCornerRadius: number

Sets axis label corner radius for EMultiPointLabelAnchorMode.Axis labels.

Optional axisLabelFill

axisLabelFill: string

Sets axis label fill for EMultiPointLabelAnchorMode.Axis labels.

Optional axisLabelPadding

axisLabelPadding: Thickness

Sets axis label padding for EMultiPointLabelAnchorMode.Axis labels.

Optional axisLabelStroke

axisLabelStroke: string

Sets axis label text color for EMultiPointLabelAnchorMode.Axis labels.

Optional axisLabelVisibility

axisLabelVisibility: EAnnotationVisibilityMode

Visibility policy for EMultiPointLabelAnchorMode.Axis labels

Default OnInteraction

Optional axisSpanFillOpacity

axisSpanFillOpacity: number

Sets fill opacity for the span drawn between adjacent EMultiPointLabelAnchorMode.Axis labels.

Optional boxOutlineStroke

boxOutlineStroke: string

Stroke for the optional box outline.

Defaults to annotation stroke.

Optional boxOutlineStrokeDashArray

boxOutlineStrokeDashArray: number[]

Dash array for the optional box outline.

Default [6, 4].

Optional boxOutlineStrokeThickness

boxOutlineStrokeThickness: number

Stroke thickness for the optional box outline.

Default 1.

Optional draggingCursor

draggingCursor: ECursorStyle

Cursor while dragging.

Optional fill

fill: string | null

The primitive triangle fill as an HTML color string. Default null -> triangles do NOT draw at all.

Optional forcedAspectRatio

forcedAspectRatio: number

Optional fixed width/height ratio used while resizing. Must be > 0.

Optional formatLabel

formatLabel: TMultiPointLabelFormatter | string

Optional custom label formatter for point/segment acnhored labels.

Optional formatLabelStyle

formatLabelStyle: TMultiPointLabelStyleFormatter | string

Optional custom style formatter for point/segment labels.

Optional gripVisibility

Visibility policy for adorner grips.

Optional hoverCursor

hoverCursor: ECursorStyle

Cursor when hovered.

Optional idleCursor

idleCursor: ECursorStyle

Cursor when idle.

Optional keepAspectRatioOnResize

keepAspectRatioOnResize: boolean

When true, corner resize keeps aspect ratio.

note

Resizing by an edge works regularly.

Optional labels

Optional label definitions.

Pair this with formatLabel for dynamic text data and formatLabelStyle for dynamic styling of point/segment labels.

Only use label.text prop for static text labels.

Optional pointLabelVisibility

pointLabelVisibility: EAnnotationVisibilityMode

Visibility policy for point labels (anchorMode: Point). Default Always.

Optional points

points: Point[]

Polyline points in value coordinates.

Optional segmentLabelVisibility

segmentLabelVisibility: EAnnotationVisibilityMode

Visibility policy for segment labels (anchorMode: Segment).

note

This only applies for EMultiPointLabelAnchorMode.Segment labels.

Default Always.

Optional showBoxOutline

showBoxOutline: boolean

Enables a resizable bounding-box outline.

Default false.

Optional showBoxOutlineOnlyWhenSelected

showBoxOutlineOnlyWhenSelected: boolean

When true, outline is only visible/interactable while annotation is selected.

Default false.

Optional snapMode

snapMode: ESnapMode

Explicit snap mode.

Optional snapToDataPoint

snapToDataPoint: boolean

Backward-compatible snap toggle.

Optional snapToDataPointOnInit

snapToDataPointOnInit: boolean

Snap initial points once after attach.

Optional snapToDataPointRadius

snapToDataPointRadius: number

Snap hit-test radius (for DataPoint mode).

If set to 0, it automatically uses XSlice data point snap mode.

Default 10

Optional snapToSeriesId

snapToSeriesId: string

Optional target series id for snapping.

Optional stroke

stroke: string

Stroke color.

Optional strokeDashArray

strokeDashArray: number[]

The strokeDashArray for the {@link LineAnnotation}

Optional strokeThickness

strokeThickness: number

Stroke thickness of the line annotation. Default 2

Generated using TypeDoc