Interface: SharesInsight

Experimental

Parts of a whole: pie slices, funnel stages, category bars, hierarchy branches, sankey flows.

Properties

Property	Modifier	Type	Description
kind	readonly	"shares"	Experimental
length	readonly	number	Experimental
part	readonly	"slice" | "bar" | "stage" | "branch" | "flow"	Experimental What a part is: 'slice', 'bar', 'stage', 'branch' or 'flow'.
total?	readonly	number	Experimental The whole, when it isn't the sum of values (sankey: flow from sources).
values	readonly	ArrayLike<number>	Experimental

Methods

formatValue()

formatValue(v): string;

Experimental

Parameters

Parameter	Type
v	number

Returns

string

---

label()

label(i): string;

Experimental

Label of part i (plain text).

Parameters

Parameter	Type
i	number

Returns

string

---

skip()?

optional skip(i): boolean;

Experimental

Parts that are hidden (legend-toggled slices) or not drawn, if any.

Parameters

Parameter	Type
i	number

Returns

boolean