Documentation menu

Interface

MarkOptions

Options of a mark (addMark, Mark.applyOptions).

Properties

NameTypeDescription
yAxis?'left' | 'right'
orientation?'vertical' | 'horizontal'
color?string | null

CSS colors; null: the palette / theme default.

downColor?string | null
totalColor?string | null
fillAlpha?number
lineWidth?number
lineStyle?'solid' | 'dashed' | 'dotted'
stepLine?boolean
pointSize?number
icon?PlotIcon
baseValue?number
group?number | null

Bars of the same group share a slot side by side; null for none.

stack?number | null

Bars or areas of the same stack add up; null for none.

band?number | null

Fraction of the slot taken by bars and cells; null for the default (0.8 / 1).

colorScale?ColorScaleOptions | null

null: the default sequential scale.

showValues?boolean
valueFormat?PlotFormat
cellSize?[ number, number ] | null

Cells on numeric axes: width and height in data units; null for automatic.

hoverable?boolean
visible?boolean

Declaration

export interface MarkOptions {
    yAxis?: 'left' | 'right';
    orientation?: 'vertical' | 'horizontal';
    color?: string | null;
    downColor?: string | null;
    totalColor?: string | null;
    fillAlpha?: number;
    lineWidth?: number;
    lineStyle?: 'solid' | 'dashed' | 'dotted';
    stepLine?: boolean;
    pointSize?: number;
    icon?: PlotIcon;
    baseValue?: number;
    group?: number | null;
    stack?: number | null;
    band?: number | null;
    colorScale?: ColorScaleOptions | null;
    showValues?: boolean;
    valueFormat?: PlotFormat;
    cellSize?: [
        number,
        number
    ] | null;
    hoverable?: boolean;
    visible?: boolean;
}

Used by

FerroPlot, Mark