Interface IBoxPlotDesc

interface IBoxPlotDesc {
    color?: string;
    colorMapping?: string | ITypedDump | ((v) => string);
    domain?: [number, number];
    filterAccuracy?: number;
    map?: ITypedDump;
    numberFormat?: string;
    range?: [number, number];
    showMinimumRepresentation?: boolean;
    sort?: ESortMethod;
}

Hierarchy (view full)

Properties

color? colorMapping? domain? filterAccuracy? map? numberFormat? range? showMinimumRepresentation? sort?

Properties

Optional color

color?: string

Deprecated

use colorMapping instead

Optional colorMapping

colorMapping?: string | ITypedDump | ((v) => string)

color mapping

Type declaration

    • (v): string

    • Parameters

      • v: number

      Returns string

Optional domain

domain?: [number, number]

either map or domain should be available

Optional filterAccuracy

filterAccuracy?: number

The accuracy defines the deviation of values to the applied filter boundary. Use an accuracy closer to 0 for columns with smaller numbers (e.g., 1e-9).

Default

0.001

Optional map

map?: ITypedDump

dump of mapping function

Optional numberFormat

numberFormat?: string

d3 formatting option

Default

.3n

Optional range

range?: [number, number]

Default

[0,1]

Optional showMinimumRepresentation

showMinimumRepresentation?: boolean

whether to render a representation of the minimum value as some visual glyph i.e. a bar with 1 px instead of 0 px

Default

false

Optional sort

sort?: ESortMethod

Settings

Member Visibility

Theme

On This Page

colorcolorMappingdomainfilterAccuracymapnumberFormatrangeshowMinimumRepresentationsort