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;
    borderDownColor?: string;
    borderUpColor?: string;
    borderVisible?: boolean;
    bottomColor?: string;
    boxSize?: number;
    closeColor?: string;
    color?: string;
    downColor?: string;
    highColor?: string;
    hollow?: boolean;
    lastValueVisible?: boolean;
    lineStyle?: "solid" | "dashed" | "dotted";
    lineWidth?: number;
    lowColor?: string;
    markerRadius?: number;
    markers?: boolean;
    markersOnly?: boolean;
    priceLineVisible?: boolean;
    step?: boolean;
    thickColor?: string;
    thinColor?: string;
    title?: string;
    topColor?: string;
    upColor?: string;
    visible?: boolean;
    volumeScaled?: boolean;
    wickDownColor?: string;
    wickUpColor?: string;
    wickVisible?: boolean;
}

Properties

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

Properties

OptionalareaBottomColor

areaBottomColor?: string

OptionalareaTopColor

areaTopColor?: string

Optionalbase

base?: number

OptionalbaseValue

baseValue?: number

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 — set this only for hand-built column data.

OptionalcloseColor

closeColor?: string

Optionalcolor

color?: string

OptionaldownColor

downColor?: string

OptionalhighColor

highColor?: string

Optionalhollow

hollow?: boolean

OptionallastValueVisible

lastValueVisible?: boolean

Show the last-value tag on the price axis. Default true.

OptionallineStyle

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

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

OptionallineWidth

lineWidth?: number

OptionallowColor

lowColor?: string

OptionalmarkerRadius

markerRadius?: number

Optionalmarkers

markers?: boolean

OptionalmarkersOnly

markersOnly?: boolean

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

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.

OptionalvolumeScaled

volumeScaled?: boolean

Scale candle body width by volume / maxVisibleVolume (volume candles).

OptionalwickDownColor

wickDownColor?: string

OptionalwickUpColor

wickUpColor?: string

OptionalwickVisible

wickVisible?: boolean

Settings

Member Visibility

On This Page

Properties