grafit-charts

---

Interface: PyramidSeriesOptions

Extends

• StandaloneSeriesBaseOptions<PyramidTooltipRendererParams>

Properties

calloutLine?

optional calloutLine?: Switchable & object

Line from a segment to its outside label (segment color by default).

Type Declaration

length?

optional length?: number

stroke?

optional stroke?: string

strokeWidth?

optional strokeWidth?: number

---

fills?

optional fills?: string[]

Inherited from

StandaloneSeriesBaseOptions.fills

---

id?

optional id?: string

Inherited from

StandaloneSeriesBaseOptions.id

---

itemSpacing?

optional itemSpacing?: number

Gap between segments (0 by default — solid pyramid).

---

label?

optional label?: Switchable & FontOptions & PartLabelBlockOptions<PyramidLabelFormatterParams> & object

Layer labels: the name and the value of a layer, drawn as one block so the two always read together — each half with its own font, layout putting the value in the same row (default) or on a line of its own. placement moves the whole block outside the shape (default) or inside it, where the text colour follows the contrast of the layer.

Type Declaration

formatter?

optional formatter?: (params) => string

The whole label at once; it wins over category/value.

Parameters

params

datum

Datum

stage

string

value

number

Returns

string

placement?

optional placement?: "outside" | "inside"

---

name?

optional name?: string

Name of what the value of a node measures — the label of the tooltip row. Without it the row is named by the data key the value came from, which is the name of a column, not of a measure.

Overrides

StandaloneSeriesBaseOptions.name

---

reverse?

optional reverse?: boolean

Bottom-up (apex at the top by default).

---

showInLegend?

optional showInLegend?: boolean

Inherited from

StandaloneSeriesBaseOptions.showInLegend

---

stageField

stageField: string

---

stageName?

optional stageName?: Formattable<PartNameParams>

How the value of stageField becomes text — for the legend, the tooltip heading and the name half of a layer label alike. A name is a field value, and the format of that field belongs to the series rather than to each place the name is printed in. label.category overrides it where a label wants something shorter than the legend.

---

tooltip?

optional tooltip?: Switchable & object

Type Declaration

renderer?

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

Parameters

params

PyramidTooltipRendererParams

Returns

string | TooltipContentData

Overrides

StandaloneSeriesBaseOptions.tooltip

---

type

type: "pyramid"

---

valueField

valueField: string

---

visible?

optional visible?: boolean

Inherited from

StandaloneSeriesBaseOptions.visible

---

widthRatio?

optional widthRatio?: number

Fraction of the plot width used by the shape (0.62 by default); independent of labels.