Documentation menu

Interface

SeriesOptions

Series options. null colors use the theme.

Properties

NameTypeDescription
color?Color | null

Line color; up candles and bars; histogram bars; baseline line above the base.

downColor?Color | null

Down candles and bars; baseline line below the base.

topFill?Color | null

Area fill at the top; baseline fill above the base.

bottomFill?Color | null

Area fill at the bottom; baseline fill below the base.

lineWidth?number

CSS px.

lineStyle?LineStyle

Dash pattern of lines. Default 'solid'.

step?boolean

Step line.

baseValue?number

Baseline fill boundary, histogram bar base.

lastValueVisible?boolean

Label with the last value on the price axis. Default true; not drawn for volume series.

priceLineVisible?boolean

Dotted horizontal line at the last value. Default true; not drawn for volume series.

shift?number

Display shift in bars.

pricePrecision?number | null

Decimals of price labels, 0 to 12. null (the default) is automatic: at least 2 decimals and 4 significant digits of the visible prices, with a subscript count of zeros for small prices (0.0₄1234 is 0.00001234).

Declaration

export interface SeriesOptions {
    color?: Color | null;
    downColor?: Color | null;
    topFill?: Color | null;
    bottomFill?: Color | null;
    lineWidth?: number;
    lineStyle?: LineStyle;
    step?: boolean;
    baseValue?: number;
    lastValueVisible?: boolean;
    priceLineVisible?: boolean;
    shift?: number;
    pricePrecision?: number | null;
}

Used by

FerroChart, Series