IFibonacciRetracementAnnotationOptions | API Documentation for SciChart Financial Tools

Options for FibonacciRetracementAnnotation.

Hierarchy

IMultiPointAnnotationBaseOptions
- 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 the optional connector line. Default [6, 4].

Optional draggingCursor

draggingCursor: ECursorStyle

Cursor while dragging.

Optional fibonacciLabelColor

fibonacciLabelColor: string

Label color used when fibonacciLabelColorMode is SingleColor. Defaults to current theme foreground color.

Optional fibonacciLabelColorMode

fibonacciLabelColorMode: EFibonacciLabelColorMode

Fibonacci region label color mode.

When using MultiColor, the labels are colored with their respective regionColors. When using SingleColor, all labels are colored with the same fibonacciLabelColor.

Default MultiColor.

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 line in top placement mode. Default 2.

Optional fibonacciLabelPlacement

fibonacciLabelPlacement: EFibonacciLabelPlacement

Position of Fibonacci labels relative to each level line. Default Left.

Optional fillOpacity

fillOpacity: number

Fill opacity for Fibonacci regions. Default 0.25.

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 retracement regions. Level stroke colors are derived from region colors:

level 0 and level 1 use regionColors[0]
each next level uses the previous region color (level i -> regionColors[i - 1])

If provided color count differs from required region count (thresholds.length - 1), extra colors are truncated and missing colors are smoothly interpolated.

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 a dashed connector between points 1 and 3. 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 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. Default [0, 0.236, 0.382, 0.5, 0.618, 0.786, 1, 1.618, 2.618, 3.618, 4.236].

Optional verticalOnly

verticalOnly: boolean

When true, locks shape to non-skewed mode (p1/p2 share Y and p2/p3 share X). Default false.