Interface BasedAxisOptions

interface BasedAxisOptions {
    binned?: boolean;
    bins?: number | any[];
    correspondingDatasets?: string[];
    domain?: AxisDomain[];
    extendLinearDomainBy?: string;
    includeZero?: boolean;
    limitDomainToBins?: boolean;
    mapsTo?: string;
    scaleType?: interfaces.ScaleTypes;
    thresholds?: interfaces.ThresholdOptions[];
    ticks?: {
        formatter?:
            | (tick: number | Date, i: number) => string
            | (tick: number | Date) => string;
        max?: number;
        min?: number;
        number?: number;
        rotateIfSmallerThan?: number;
        rotation?: interfaces.TickRotations;
        values?: any[];
    };
    title?: string;
    titleOrientation?: string;
    truncation?: interfaces.TruncationOptions;
    visible?: boolean;
}

Hierarchy (View Summary)

Properties

binned? bins? correspondingDatasets? domain? extendLinearDomainBy? includeZero? limitDomainToBins? mapsTo? scaleType? thresholds? ticks? title? titleOrientation? truncation? visible?

Properties

Optionalbinned

binned?: boolean

should be set to true on the domain axis that's being broken into bins

Optionalbins

bins?: number | any[]

Bins to display (Histogram) bins: 20 bins: [0, 20, 40, 60] bins: [new Date(...), new Date(...), ...]

OptionalcorrespondingDatasets

correspondingDatasets?: string[]

used to map data on the secondary axis

Optionaldomain

domain?: AxisDomain[]

Whether the Axis should use the specified domain instead of it being dynamically generated based on data extents. The type of values should depend on the scale type. Example for continuous axis scale: [-100, 100] Example for discrete axis scale: ['Qty', 'More', 'Sold'] No need to define domain for percentage axis scale

OptionalextendLinearDomainBy

extendLinearDomainBy?: string

an additional key from the charting data that is used to extend the domain of an axis by (e.g. in the bullet graph we need both the marker & the data values to define the domain of the linear scale)

OptionalincludeZero

includeZero?: boolean

Whether the Axis should be forced to include 0 as a starting point (or ending point, in case of all negative axis). Default: true

OptionallimitDomainToBins

limitDomainToBins?: boolean

limit the visible axis domain to only the binned area

OptionalmapsTo

mapsTo?: string

identifies what key within the data the axis values would map to

OptionalscaleType

scaleType?: interfaces.ScaleTypes

type of the scale used on axis

Optionalthresholds

thresholds?: interfaces.ThresholdOptions[]

thresholds

Example

[
		{ value: 10000 },
		{ value: 40020, valueFormatter: (x) => x },
		{ value: 55000, label: "Custom label", fillColor: "#03a9f4" },
]

Optionalticks

ticks?: {
    formatter?:
        | (tick: number | Date, i: number) => string
        | (tick: number | Date) => string;
    max?: number;
    min?: number;
    number?: number;
    rotateIfSmallerThan?: number;
    rotation?: interfaces.TickRotations;
    values?: any[];
}

tick configuration

Type declaration

  • Optionalformatter?: (tick: number | Date, i: number) => string | (tick: number | Date) => string

    function to format the ticks

  • Optionalmax?: number

    maximum tick value

  • Optionalmin?: number

    minimum tick value

  • Optionalnumber?: number

    number of ticks to show

  • OptionalrotateIfSmallerThan?: number

    minimum width of a tick before getting rotated (in pixels)

  • Optionalrotation?: interfaces.TickRotations

    when to rotate ticks

  • Optionalvalues?: any[]

    optional array of tick values that is within the domain of data

Optionaltitle

title?: string

optional title for the scales

OptionaltitleOrientation

titleOrientation?: string

Override for the orientation of the title (for vertical axes). The title string can be overrided to be rotated left or right.

Optionaltruncation

truncation?: interfaces.TruncationOptions

Optionalvisible

visible?: boolean

is axis visible or not

Settings

Member Visibility

On This Page

Properties