Skip to content

grafit-charts


Interface: HistogramSeriesOptions

Extends

  • Omit<SeriesBaseOptions, "yField" | "name">

Properties

aggregation?

optional aggregation?: "count" | "sum" | "mean"


binCount?

optional binCount?: number


bins?

optional bins?: [number, number][]

Explicit bin edges: [[min,max], ...].


fill?

optional fill?: string


fillOpacity?

optional fillOpacity?: number


id?

optional id?: string

Inherited from

LineSeriesOptions.id


label?

optional label?: Switchable & FontOptions & object

Value labels: same placements as bar (top, inner-top, center, …).

Type Declaration

formatter?

optional formatter?: (params) => string

Parameters
params
value

number

x0

number

x1

number

Returns

string

placement?

optional placement?: RectLabelPlacement


name?

optional name?: string


showInLegend?

optional showInLegend?: boolean

Inherited from

LineSeriesOptions.showInLegend


stroke?

optional stroke?: string


strokeWidth?

optional strokeWidth?: number


tooltip?

optional tooltip?: Switchable & object

Type Declaration

renderer?

optional renderer?: (params) => string | TooltipContentData

Parameters
params

SeriesTooltipRendererParams

Returns

string | TooltipContentData

Inherited from

LineSeriesOptions.tooltip


type

type: "histogram"


visible?

optional visible?: boolean

Inherited from

Showable.visible


xField

xField: string

Numeric field used to build the bins.

Overrides

LineSeriesOptions.xField


xName?

optional xName?: string

Inherited from

LineSeriesOptions.xName


yField?

optional yField?: string

Aggregation field; without it the count is used.