IPitchforkAnnotationOptions | API Documentation for SciChart Financial Tools

Options for PitchforkAnnotation.

Hierarchy

IMultiPointAnnotationBaseOptions
- IPitchforkAnnotationOptions
  - IPitchfanAnnotationOptions

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

draggingCursor: ECursorStyle

Cursor while dragging.

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 fullWidthZoneFill

fullWidthZoneFill: string

Fill for the outer (full shoulder-width) channel zone. Default semi-transparent blue.

Optional fullWidthZoneStroke

fullWidthZoneStroke: string

Stroke for the outer (full shoulder-width) channel zone. Default solid blue.

Optional gripVisibility

gripVisibility: EAnnotationVisibilityMode

Visibility policy for adorner grips.

Optional halfWidthZoneFill

halfWidthZoneFill: string

Fill for the inner (half shoulder-width) channel zone. Default semi-transparent green.

Optional halfWidthZoneStroke

halfWidthZoneStroke: string

Stroke for the inner (half shoulder-width) channel zone. Default solid green.

Optional hoverCursor

hoverCursor: ECursorStyle

Cursor when hovered.

Optional idleCursor

idleCursor: ECursorStyle

Cursor when idle.

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 segmentLabelVisibility

segmentLabelVisibility: EAnnotationVisibilityMode

Visibility policy for segment labels (anchorMode: Segment).

note

This only applies for EMultiPointLabelAnchorMode.Segment labels.

Default Always.

Optional showFullWidthZone

showFullWidthZone: boolean

Shows the outer (full shoulder-width) channel zone. Default true.

Optional showHalfWidthZone

showHalfWidthZone: boolean

Shows the inner (half shoulder-width) channel zone. Default true.

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 for top pitchfork lines.

Optional strokeDashArray

strokeDashArray: number[]

Optional dash array for top pitchfork lines.

Optional strokeThickness

strokeThickness: number

Stroke thickness for top pitchfork lines.