chartjs-plugin-hierarchical v4.4.0 / HierarchicalScaleType

Interface: HierarchicalScaleType

Extends

• Partial<IHierarchicalScaleOptions>

Properties

attributes?

optional attributes: Object

object of attributes that should be managed and extracted from the tree data structures such as backgroundColor for coloring individual bars the object contains the key and default value

Default

{}

Index signature

[attribute: string]: any

Inherited from

Partial.attributes

Source

work/chartjs-plugin-hierarchical/chartjs-plugin-hierarchical/src/scale/hierarchical.ts:66

---

hierarchyBoxColor?

optional hierarchyBoxColor: string

color of the box to toggle collapse/expand

Inherited from

Partial.hierarchyBoxColor

Source

work/chartjs-plugin-hierarchical/chartjs-plugin-hierarchical/src/scale/hierarchical.ts:54

---

hierarchyBoxLineHeight?

optional hierarchyBoxLineHeight: number

distance between two hierarchy indicators

Inherited from

Partial.hierarchyBoxLineHeight

Source

work/chartjs-plugin-hierarchical/chartjs-plugin-hierarchical/src/scale/hierarchical.ts:42

---

hierarchyBoxSize?

optional hierarchyBoxSize: number

size of the box to draw

Inherited from

Partial.hierarchyBoxSize

Source

work/chartjs-plugin-hierarchical/chartjs-plugin-hierarchical/src/scale/hierarchical.ts:38

---

hierarchyBoxWidth?

optional hierarchyBoxWidth: number

stroke width of the toggle box

Inherited from

Partial.hierarchyBoxWidth

Source

work/chartjs-plugin-hierarchical/chartjs-plugin-hierarchical/src/scale/hierarchical.ts:58

---

hierarchyGroupLabelPosition?

optional hierarchyGroupLabelPosition: "center" | "first" | "last" | "between-first-and-second"

position of the hierarchy group label relative to the its children

Default

between-first-and-second

Inherited from

Partial.hierarchyGroupLabelPosition

Source

work/chartjs-plugin-hierarchical/chartjs-plugin-hierarchical/src/scale/hierarchical.ts:28

---

hierarchyLabelPosition?

optional hierarchyLabelPosition: null | "none" | "below" | "above"

position of the hierarchy label in expanded levels, 'none' to disable

Default

'below'

Inherited from

Partial.hierarchyLabelPosition

Source

work/chartjs-plugin-hierarchical/chartjs-plugin-hierarchical/src/scale/hierarchical.ts:22

---

hierarchySpanColor?

optional hierarchySpanColor: string

color of the line indicator hierarchy children

Inherited from

Partial.hierarchySpanColor

Source

work/chartjs-plugin-hierarchical/chartjs-plugin-hierarchical/src/scale/hierarchical.ts:46

---

hierarchySpanWidth?

optional hierarchySpanWidth: number

stroke width of the line

Inherited from

Partial.hierarchySpanWidth

Source

work/chartjs-plugin-hierarchical/chartjs-plugin-hierarchical/src/scale/hierarchical.ts:50

---

levelPercentage?

optional levelPercentage: number

ratio by which the distance between two elements shrinks the higher the level of the tree is. i.e. two two level bars have a distance of 1. two nested one just 0.75

Default

0.75

Inherited from

Partial.levelPercentage

Source

work/chartjs-plugin-hierarchical/chartjs-plugin-hierarchical/src/scale/hierarchical.ts:12

---

offset?

optional offset: true

Inherited from

Partial.offset

Source

work/chartjs-plugin-hierarchical/chartjs-plugin-hierarchical/src/scale/hierarchical.ts:68

---

padding?

optional padding: number

padding of the first collapse to the start of the x-axis

Default

25

Inherited from

Partial.padding

Source

work/chartjs-plugin-hierarchical/chartjs-plugin-hierarchical/src/scale/hierarchical.ts:17

---

reverseOrder?

optional reverseOrder: boolean

if reverseOrder is true the lowest hierarchy level is on axis level and the highest level is the one furthest from axis

Default

false

Inherited from

Partial.reverseOrder

Source

work/chartjs-plugin-hierarchical/chartjs-plugin-hierarchical/src/scale/hierarchical.ts:73

---

static?

optional static: boolean

whether interactive buttons should be shown or whether it should be static

Default

false

Inherited from

Partial.static

Source

work/chartjs-plugin-hierarchical/chartjs-plugin-hierarchical/src/scale/hierarchical.ts:34

---

type

type: "hierarchical"

Source

work/chartjs-plugin-hierarchical/chartjs-plugin-hierarchical/src/scale/hierarchical.ts:297