Class PyramidChartWithLabelsInsideSlices

Properties

engine

engine: PublicEngine

pixelScale

pixelScale: Vec2<Scale>

uiScale

uiScale: Vec2<Scale>

Methods

addLegendBox

addLegendBox(builder: UIElementBuilder<UIElementType>, scale: Vec2<Scale>): UIElementType & UIElement

Type parameters
- UIElementType: UIPart
Parameters
- Default value builder: UIElementBuilder<UIElementType>
- Default value scale: Vec2<Scale>
Returns UIElementType & UIElement

LegendBox that fulfills interfaces: UIElementType (typeparam) and UIElement

addSlice

addSlice(title: string, value: number): PyramidSlice

Implementation of SlicedCharts.addSlice

Parameters
- title: string
- value: number
Returns PyramidSlice

addSlices

addSlices(slices: object[]): Array<PyramidSlice>

Parameters
- slices: object[]
Returns Array<PyramidSlice>

addUIElement

addUIElement(builder: UIElementBuilder<UIElementType>, scale: Vec2<Scale>): UIElementType & UIElement

Type parameters
- UIElementType: UIPart
Parameters
- Default value builder: UIElementBuilder<UIElementType>
- Default value scale: Vec2<Scale>
Returns UIElementType & UIElement

Object that fulfills interfaces: UIElementType (typeparam) and UIElement

disableAnimations

disableAnimations(): this

Returns this

Chart itself for fluent interface.

dispose

dispose(): this

Returns this

Object itself for fluent interface

getAnimationsEnabled

getAnimationsEnabled(): boolean

Returns boolean

Boolean state for animations enabled

getBackgroundFillStyle

getBackgroundFillStyle(): FillStyle

Returns FillStyle

FillStyle

getBackgroundStrokeStyle

getBackgroundStrokeStyle(): LineStyle

Returns LineStyle

LineStyle

getLabelFillStyle

getLabelFillStyle(): FillStyle

Implementation of SlicedCharts.getLabelFillStyle

Returns FillStyle

FillStyle object

getLabelFont

getLabelFont(): FontSettings

Implementation of SlicedCharts.getLabelFont

Returns FontSettings

FontSettings

getLabelFormatter

getLabelFormatter(): SliceLabelFormatter<PyramidSlice>

Implementation of SlicedCharts.getLabelFormatter

Returns SliceLabelFormatter<PyramidSlice>

SliceLabelFormatter - function which generates text of Labels per Slice.

getMinimumSize

getMinimumSize(): Point | undefined

Returns Point | undefined

Point

getNeckWidth

getNeckWidth(): number

Returns number

number (0 - 100)

getPadding

getPadding(): Margin

Returns Margin

Padding datastructure

getPyramidSliceMode

getPyramidSliceMode(): PyramidSliceModes

Returns PyramidSliceModes

PyramidSliceMode

getSliceFillStyle

getSliceFillStyle(): Palette<FillStyle>

Implementation of SlicedCharts.getSliceFillStyle

Returns Palette<FillStyle>

Palette

getSliceSorter

getSliceSorter(): SliceSorter<PyramidSlice>

Implementation of SlicedCharts.getSliceSorter

Returns SliceSorter<PyramidSlice>

SliceSorter - function which sorts Slices of Pyramid with JavaScript API: Array.sort.

getSliceStrokeStyle

getSliceStrokeStyle(): LineStyle

Implementation of SlicedCharts.getSliceStrokeStyle

Returns LineStyle

LineStyle object

getSlices

getSlices(): PyramidSlice[]

Returns PyramidSlice[]

Array of Slices

getTitle

getTitle(): string

Returns string

Chart title as a string.

getTitleFillStyle

getTitleFillStyle(): FillStyle

Returns FillStyle

FillStyle object

getTitleFont

getTitleFont(): FontSettings

Returns FontSettings

FontSettings object

getTitleMarginBottom

getTitleMarginBottom(): number

Returns number

Padding after Chart title

getTitleMarginTop

getTitleMarginTop(): number

Returns number

Padding before Chart title

offResize

offResize(token: Token): boolean

Parameters
- token: Token
Returns boolean

True if the listener is successfully removed and false if it is not found

onResize

onResize(handler: function): Token

Parameters
- handler: function
  - - Parameters
      - obj: this
      - width: pixel
      - height: pixel
      - engineWidth: pixel
      - engineHeight: pixel
      Returns void
Returns Token

Token of subscription

saveToFile

saveToFile(fileName: string, type: undefined | string, encoderOptions: undefined | number): this

Parameters
- fileName: string
- Optional type: undefined | string
- Optional encoderOptions: undefined | number
Returns this

setAnimationsEnabled

setAnimationsEnabled(animationsEnabled: boolean): this

Parameters
- animationsEnabled: boolean
Returns this

Pyramid Chart itself

setBackgroundFillStyle

setBackgroundFillStyle(value: FillStyle | ImmutableMutator<FillStyle>): this

Parameters
- value: FillStyle | ImmutableMutator<FillStyle>
Returns this

Object itself

setBackgroundStrokeStyle

setBackgroundStrokeStyle(value: LineStyle | ImmutableMutator<LineStyle>): this

Parameters
- value: LineStyle | ImmutableMutator<LineStyle>
Returns this

Object itself

setLUT

setLUT(value: LUT): this

Implementation of SlicedCharts.setLUT

Parameters
- value: LUT
Returns this

Pyramid itself for fluent interface

setLabelFillStyle

setLabelFillStyle(value: FillStyle | ImmutableMutator<FillStyle>): this

Implementation of SlicedCharts.setLabelFillStyle

Parameters
- value: FillStyle | ImmutableMutator<FillStyle>
Returns this

Pyramid Chart itself

setLabelFont

setLabelFont(value: FontSettings | ImmutableMutator<FontSettings>): this

Implementation of SlicedCharts.setLabelFont

Parameters
- value: FontSettings | ImmutableMutator<FontSettings>
Returns this

Pyramid Chart itself

setLabelFormatter

setLabelFormatter(labelFormatter: SliceLabelFormatter<PyramidSlice>): this

Implementation of SlicedCharts.setLabelFormatter

Parameters
- labelFormatter: SliceLabelFormatter<PyramidSlice>
Returns this

Pyramid Chart itself

setNeckWidth

setNeckWidth(neckWidth: number): this

Parameters
- neckWidth: number
Returns this

Pyramid Chart itself

setPadding

setPadding(padding: Partial<Margin> | number): this

Parameters
- padding: Partial<Margin> | number
Returns this

Object itself

setSliceFillStyle

setSliceFillStyle(sliceFillStylePalette: Palette<FillStyle>): this

Implementation of SlicedCharts.setSliceFillStyle

Parameters
- sliceFillStylePalette: Palette<FillStyle>
Returns this

Pyramid Chart itself

setSliceGap

setSliceGap(sliceGap: pixel): this

Parameters
- sliceGap: pixel
Returns this

Pyramid Chart itself

setSliceHighlightOnHover

setSliceHighlightOnHover(state: boolean): this

Implementation of SlicedCharts.setSliceHighlightOnHover

Parameters
- state: boolean
Returns this

setSliceMode

setSliceMode(sliceMode: PyramidSliceModes): this

Parameters
- sliceMode: PyramidSliceModes
Returns this

Pyramid Chart itself

setSliceSorter

setSliceSorter(sliceSorter: SliceSorter<PyramidSlice>): this

Implementation of SlicedCharts.setSliceSorter

Parameters
- sliceSorter: SliceSorter<PyramidSlice>
Returns this

Pyramid Chart itself

setSliceStrokeStyle

setSliceStrokeStyle(value: LineStyle | ImmutableMutator<LineStyle>): this

Implementation of SlicedCharts.setSliceStrokeStyle

Parameters
- value: LineStyle | ImmutableMutator<LineStyle>
Returns this

Pyramid Chart itself

setTitle

setTitle(title: string): this

Parameters
- title: string
Returns this

Object itself for fluent interface.

setTitleFillStyle

setTitleFillStyle(value: FillStyle | ImmutableMutator<FillStyle>): this

Parameters
- value: FillStyle | ImmutableMutator<FillStyle>
Returns this

Chart itself

setTitleFont

setTitleFont(value: FontSettings | ImmutableMutator<FontSettings>): this

Parameters
- value: FontSettings | ImmutableMutator<FontSettings>
Returns this

Chart itself

setTitleMarginBottom

setTitleMarginBottom(marginPixels: pixel): this

Parameters
- marginPixels: pixel
Returns this

Chart itself for fluent interface

setTitleMarginTop

setTitleMarginTop(marginPixels: pixel): this

Parameters
- marginPixels: pixel
Returns this

Chart itself for fluent interface