Interface SeriesStyle

Unified style bag for all Family-A series types (ARCHITECTURE.md §6A). Each renderer reads the fields it needs; per-type defaults are filled by the chart-type registry. Keeping one optional-field interface avoids a sprawling discriminated union at the rendering boundary.

interface SeriesStyle {
    areaBottomColor?: string;
    areaTopColor?: string;
    base?: number;
    baseValue?: number;
    bodyVisible?: boolean;
    borderDownColor?: string;
    borderUpColor?: string;
    borderVisible?: boolean;
    bottomColor?: string;
    boxSize?: number;
    closeColor?: string;
    color?: string;
    colorByPreviousClose?: boolean;
    downColor?: string;
    highColor?: string;
    hollow?: boolean;
    lastValueVisible?: boolean;
    lineStyle?: "solid" | "dashed" | "dotted";
    lineWidth?: number;
    lowColor?: string;
    markerRadius?: number;
    markers?: boolean;
    markersOnly?: boolean;
    precision?: number;
    priceLineVisible?: boolean;
    step?: boolean;
    thickColor?: string;
    thinColor?: string;
    title?: string;
    topColor?: string;
    upColor?: string;
    visible?: boolean;
    wickDownColor?: string;
    wickUpColor?: string;
    wickVisible?: boolean;
}

Properties

areaBottomColor? areaTopColor? base? baseValue? bodyVisible? borderDownColor? borderUpColor? borderVisible? bottomColor? boxSize? closeColor? color? colorByPreviousClose? downColor? highColor? hollow? lastValueVisible? lineStyle? lineWidth? lowColor? markerRadius? markers? markersOnly? precision? priceLineVisible? step? thickColor? thinColor? title? topColor? upColor? visible? wickDownColor? wickUpColor? wickVisible?

Properties

OptionalareaBottomColor

areaBottomColor?: string

OptionalareaTopColor

areaTopColor?: string

Optionalbase

base?: number

OptionalbaseValue

baseValue?: number

OptionalbodyVisible

bodyVisible?: boolean

Paint candle bodies. Off leaves outline and wick. Default true.

OptionalborderDownColor

borderDownColor?: string

OptionalborderUpColor

borderUpColor?: string

OptionalborderVisible

borderVisible?: boolean

OptionalbottomColor

bottomColor?: string

OptionalboxSize

boxSize?: number

Fallback box size for stacking P&F X/O glyphs. Columns from PointFigureTransform carry their own boxSize, which wins, so set this only for hand-built column data.

OptionalcloseColor

closeColor?: string

Optionalcolor

color?: string

OptionalcolorByPreviousClose

colorByPreviousClose?: boolean

Color bars by close-versus-previous-close instead of close-versus-own-open, which is how most terminals paint a bar. Body, border and wick switch together. Default false.

OptionaldownColor

downColor?: string

OptionalhighColor

highColor?: string

Stroke for the top edge of an HLC area's band. Undefined leaves the edge unstroked, which is how the band has always drawn.

Optionalhollow

hollow?: boolean

OptionallastValueVisible

lastValueVisible?: boolean

Show this series' current value as a tag on the price axis. Default true.

Every series on the pane's readout scale gets one, not only the instrument: an indicator overlay, a comparison line, a study on a pane of its own. The instrument's tag is the up/down coloured one that also carries the bar countdown; the rest are drawn in their own plot colour. A series whose current value is not a number draws no tag, so a study that is na right now says nothing rather than showing a stale reading.

OptionallineStyle

lineStyle?: "solid" | "dashed" | "dotted"

Line dash style for line/step/area/HLC series. Default 'solid'.

OptionallineWidth

lineWidth?: number

OptionallowColor

lowColor?: string

Stroke for the bottom edge of an HLC area's band. See highColor.

OptionalmarkerRadius

markerRadius?: number

Optionalmarkers

markers?: boolean

OptionalmarkersOnly

markersOnly?: boolean

Draw only the markers, with no connecting line (Parabolic SAR, scatter).

Optionalprecision

precision?: number

Decimal places for every price the scale this series maps to formats: the axis ticks, the last-value tag, the crosshair label and the drawing-tool labels. It overrides the precision the price scale infers from the tick size or the visible range. Undefined is the "Default" entry of the Precision dropdown: keep inferring. Valid range 0 to 8.

It does not reach a legend row: a PaneLegend is handed finished strings, so whoever builds those readings owns their formatting.

OptionalpriceLineVisible

priceLineVisible?: boolean

Show the dashed horizontal last-price line across the plot. Default true.

Optionalstep

step?: boolean

OptionalthickColor

thickColor?: string

Kagi thick (yang) line color.

OptionalthinColor

thinColor?: string

Kagi thin (yin) line color.

Optionaltitle

title?: string

Optional label carried with the series (for host-drawn legends).

OptionaltopColor

topColor?: string

OptionalupColor

upColor?: string

Optionalvisible

visible?: boolean

Whether the series is drawn and counted in autoscale. Default true.

OptionalwickDownColor

wickDownColor?: string

OptionalwickUpColor

wickUpColor?: string

OptionalwickVisible

wickVisible?: boolean

Settings

Member Visibility

On This Page

Properties