Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IMeasureAnnotationOptions

Go to JavaScript Charting Documentation
Go to JavaScript Chart Examples
Go to SciChart.js on Github

Hierarchy

Index

Properties

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 arrowHeadLength

arrowHeadLength: number

Length of arrow heads in CSS pixels. Default 10.

Optional arrowHeadWidth

arrowHeadWidth: number

Width of arrow heads in CSS pixels. Default 8.

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 decliningColor

decliningColor: string

Stroke and fill color used when the measured value decreases. Default "#DC2626".

Optional draggingCursor

draggingCursor: ECursorStyle

Cursor while dragging.

Optional fillOpacity

fillOpacity: number

Fill opacity for the measured rectangle. Default 0.18.

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

gripVisibility: EAnnotationVisibilityMode

Visibility policy for adorner grips.

Optional growingColor

growingColor: string

Stroke and fill color used when the measured value increases. Default "#2563EB".

Optional hoverCursor

hoverCursor: ECursorStyle

Cursor when hovered.

Optional idleCursor

idleCursor: ECursorStyle

Cursor when idle.

Optional labelCornerRadius

labelCornerRadius: number

Label corner radius in CSS pixels. Default 4.

Optional labelDataTemplate

labelDataTemplate: TMeasureLabelDataTemplate

Optional labelFontFamily

labelFontFamily: string

Label font family. Defaults to the SciChart default font.

Optional labelFontSize

labelFontSize: number

Label font size in CSS pixels. Default 12.

Optional labelFontStyle

labelFontStyle: string

Label font style. Default "Normal".

Optional labelFontWeight

labelFontWeight: string

Label font weight. Default "400".

Optional labelOffset

labelOffset: number

Label offset from the measured shape in CSS pixels. Default 8.

Optional labelPadding

labelPadding: Thickness

Label padding. Default new Thickness(6, 10, 6, 10).

Optional labelTextColor

labelTextColor: string

Label text color. Default "#FFFFFF".

Optional labels

labels: IMultiPointLabelDefinition[]

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 rectStrokeDashArray

rectStrokeDashArray: number[]

Dash array for the measured rectangle stroke. Default [].

Optional rectStrokeThickness

rectStrokeThickness: number

Stroke thickness for the measured rectangle. Default 1.

Optional segmentLabelVisibility

segmentLabelVisibility: EAnnotationVisibilityMode

Visibility policy for segment labels (anchorMode: Segment).

note

This only applies for EMultiPointLabelAnchorMode.Segment labels.

Default Always.

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 strokeThickness

strokeThickness: number

Stroke thickness for the measure line. Default 1.

Optional yValueScaleFactor

yValueScaleFactor: number

Multiplier used for displayed Y-value change. Default 100.

Generated using TypeDoc