grafit-charts

---

Interface: RangeBarSeriesOptions

Extends

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

Properties

cornerRadius?

optional cornerRadius?: number

---

direction?

optional direction?: "vertical" | "horizontal"

---

fill?

optional fill?: string | RangeBarFillFn

Bar fill. A callback receives each datum and returns a color — use it to paint bars by category/status (e.g. a Gantt chart coloured by task state). itemStyler does the same the way every other series does, and is laid over it.

---

fillOpacity?

optional fillOpacity?: number

---

groupGap?

optional groupGap?: number

Gap between bars of one category group — fraction of the slot step (0–0.9, default 0.2). Ignored when the series is alone in the band.

---

id?

optional id?: string

Inherited from

LineSeriesOptions.id

---

itemStyler?

optional itemStyler?: Styler<RangeBarItemStylerParams, RectItemStyle>

Style of one bar by its datum. Undefined leaves the bar as fill paints it; a partial style is laid over it.

---

label?

optional label?: Switchable & FontOptions & LabelOverlapOptions & object

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

Type Declaration

formatter?

optional formatter?: (params) => string

Parameters

params

datum

Datum

high

number

low

number

Returns

string

placement?

optional placement?: RectLabelPlacement

---

name?

optional name?: string

---

showInLegend?

optional showInLegend?: boolean

Inherited from

LineSeriesOptions.showInLegend

---

tooltip?

optional tooltip?: Switchable & object

Type Declaration

renderer?

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

Parameters

params

RangeTooltipRendererParams

Returns

string | TooltipContentData

Inherited from

Omit.tooltip

---

type

type: "range-bar"

---

visible?

optional visible?: boolean

Inherited from

Showable.visible

---

xField

xField: string

Inherited from

LineSeriesOptions.xField

---

xName?

optional xName?: string

Inherited from

LineSeriesOptions.xName

---

yHighField

yHighField: string

---

yLowField

yLowField: string