Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PyramidOptions<PyramidChartType>

Interface that can be used to define PyramidChart configurations, when inside a Dashboard, that can't be changed after creation.

Example usage:

// Pyramid Chart with default type
undefined
// Pyramid Chart with specified type
{ pyramidOptions: { type: PyramidChartTypes.LabelsInsideSlices } }

Index

Properties

columnIndex

columnIndex : number

Column index on dashboard (X location, 0 = left)

Optional columnSpan

columnSpan : undefined | number

Column span (X width), default = 1

Optional disableAnimations

disableAnimations : undefined | false | true

Disable animations by default

rowIndex

rowIndex : number

Row index on dashboard (Y location, 0 = top)

Optional rowSpan

rowSpan : undefined | number

Row span (Y height), default = 1

Optional theme

theme : Theme

Theme used to style all elements inside the Chart. See Themes for pre-made options.

Optional type

Interface for specifying desired "type" of Pyramid Chart. This can be used to select different rendering approaches, mainly reflecting how Slice Labels are positioned.

Options are located in PyramidChartTypes collection. If undefined, will default to PyramidChartWithLabelsOnSides.