Documentation menu

Interface

RuleOptions

Options of addRule / Rule.applyOptions.

Properties

NameTypeDescription
axis?AxisName

The axis of value; 'x' gives a vertical rule. Default 'right'.

value?number
to?number | null

Other edge of a band; null for a line.

color?string | null
lineWidth?number
lineStyle?'solid' | 'dashed' | 'dotted'
label?string | null

Text on the axis; null for none.

labelBackground?boolean

Declaration

export interface RuleOptions {
    axis?: AxisName;
    value?: number;
    to?: number | null;
    color?: string | null;
    lineWidth?: number;
    lineStyle?: 'solid' | 'dashed' | 'dotted';
    label?: string | null;
    labelBackground?: boolean;
}

Used by

FerroPlot, Rule