IFibonacciAnnotationBaseOptions | API Documentation for SciChart Financial Tools

Common options shared by Fibonacci annotations.

Hierarchy

IMultiPointAnnotationBaseOptions
- IFibonacciAnnotationBaseOptions
  - IFibonacciArcAnnotationBaseOptions
  - IFibonacciRetracementAnnotationOptions

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 connectorLineStroke

connectorLineStroke: string

Connector line stroke color. Defaults to the resolved grip stroke color.

Optional connectorLineStrokeDashArray

connectorLineStrokeDashArray: number[]

Dash array for optional connector line(s).

Optional draggingCursor

draggingCursor: ECursorStyle

Cursor while dragging.

Optional fibonacciLabelColor

fibonacciLabelColor: string

Label color used when fibonacciLabelColorMode is SingleColor.

Optional fibonacciLabelColorMode

fibonacciLabelColorMode: EFibonacciLabelColorMode

Fibonacci label color mode.

Optional fibonacciLabelFontSize

fibonacciLabelFontSize: number

Fibonacci label font size in px. If not set, uses current yAxis label font size.

Optional fibonacciLabelLinePadding

fibonacciLabelLinePadding: number

Extra spacing between Fibonacci labels and their level line/arc.

Optional fibonacciLabelPlacement

fibonacciLabelPlacement: EFibonacciLabelPlacement

Position of Fibonacci labels relative to each level.

Optional fillOpacity

fillOpacity: number

Fill opacity for Fibonacci regions.

Optional formatFibonacciLabel

formatFibonacciLabel: TFibonacciLevelLabelFormatter | string

Optional custom formatter for Fibonacci label text.

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

regionColors: string[]

Colors used for Fibonacci regions. Level stroke colors are derived from region colors.

Optional segmentLabelVisibility

segmentLabelVisibility: EAnnotationVisibilityMode

Visibility policy for segment labels (anchorMode: Segment).

note

This only applies for EMultiPointLabelAnchorMode.Segment labels.

Default Always.

Optional showConnectorLine

showConnectorLine: boolean

Whether to show connector line(s) between defining points.

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 Fibonacci level lines.

Optional thresholds

thresholds: number[]

Threshold values used for level calculation and labels. Regions are drawn between each pair of consecutive thresholds.