Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SlicedCharts <T >

Interface exists for enforcing shared APIs between Pie, Funnel and Pyramid Charts.

Implemented by

Index

Methods

Methods

addSlice

  • addSlice(title: string, value: number): T

  • This method is used for the adding slices in the Chart.

    Parameters

    • title: string

      Slice title

    • value: number

      Slice value

    Returns T

addSlices

  • addSlices(multiSlice: object[]): Array<T>

  • This method is used for the adding multiple slices in the Chart.

    Parameters

    • multiSlice: object[]

      Array of slices

    Returns Array<T>

getLabelFillStyle

  • Get fill style of Slice Labels.

    Returns FillStyle

    FillStyle object

getLabelFont

  • Get font of Slice Labels.

    Returns FontSettings

    FontSettings

getLabelFormatter

  • Get formatter of Slice Labels.

    Returns SliceLabelFormatter<T>

    SliceLabelFormatter - function which generates text of Labels per Slice.

getSliceFillStyle

  • Get style of Slices fill. This style is managed as a continuous Palette of FillStyle objects. Each Slice of Chart will be assigned an incremental index, which will be used to pick its fill style from this Palette.

    So, for example... We have a Sliced Chart with 5 Slices, and we give it a Palette with only 3 possible values (0 = red, 1 = green, 2 = blue). The resulting Slice fill styles will be: red, green, blue, red, green. Note that this means, that the supplied Palette will have to work in a continuous manner!

    Returns Palette<FillStyle>

    Palette

getSliceSorter

  • Get sorter of Slices as a comparator-function.

    Returns SliceSorter<T>

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

getSliceStrokeStyle

  • getSliceStrokeStyle(): LineStyle

  • Get style of Slices Stroke.

    Returns LineStyle

    LineStyle object

setLUT

  • setLUT(value: LUT): this

  • Set lookup table

    value

    lookup table

    Parameters

    Returns this

    Chart itself

setLabelFillStyle

  • Set fill style of Slices Labels.

    Parameters

    Returns this

    Chart itself

setLabelFont

setLabelFormatter

  • Set formatter of Slice Labels.

    See SliceLabelFormatters for a collection of default options.

    Parameters

    • labelFormatter: SliceLabelFormatter<T>

      SliceLabelFormatter - function which generates text of Labels per Slice.

    Returns this

    Chart itself

setSliceFillStyle

  • Set style of Slices fill. This style is managed as a continuous Palette of FillStyle objects. Each Slice of Chart will be assigned an incremental index, which will be used to pick its fill style from this Palette.

    So, for example... We have a Sliced Chart with 5 Slices, and we give it a Palette with only 3 possible values (0 = red, 1 = green, 2 = blue). The resulting Slice fill styles will be: red, green, blue, red, green. Note that this means, that the supplied Palette will have to work in a continuous manner!

    Parameters

    Returns this

    Chart itself

setSliceSorter

  • Set sorter of Slices as a comparator-function.

    For some commonly needed default implementations, can refer to SliceSorters collection.

    Parameters

    • sliceSorter: SliceSorter<T>

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

    Returns this

    Chart itself

setSliceStrokeStyle

  • Set style of Slices Stroke.

    Parameters

    • value: LineStyle | ImmutableMutator<LineStyle>

      LineStyle object or function which creates a new style based on previous

    Returns this

    Chart itself