Interface SlicedCharts<T>

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

Type Parameters

Hierarchy

  • SlicedCharts

Implemented by

Methods

addSlice addSlices getLabelFillStyle getLabelFont getLabelFormatter getSliceFillStyle getSliceSorter getSliceStrokeStyle setLUT setLabelFillStyle setLabelFont setLabelFormatter setSliceFillStyle setSliceHighlightOnHover setSliceSorter setSliceStrokeStyle

Methods

addSlice

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

    Parameters

    • title: string

      Slice title

    • value: number

      Slice value

    Returns T

addSlices

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

    Parameters

    • multiSlice: {
          name: string;
          value: number;
      }[]

      Array of slices

    Returns T[]

getLabelFillStyle

  • Get fill style of Slice Labels.

    Returns

    FillStyle object

    Returns FillStyle

getLabelFont

getLabelFormatter

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

    Returns Palette<FillStyle>

getSliceSorter

  • Get sorter of Slices as a comparator-function.

    Returns

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

    Returns SliceSorter<T>

getSliceStrokeStyle

  • Get style of Slices Stroke.

    Returns

    LineStyle object

    Returns LineStyle

setLUT

setLabelFillStyle

setLabelFont

setLabelFormatter

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!

    Returns

    Chart itself

    Parameters

    Returns SlicedCharts<T>

setSliceHighlightOnHover

  • Set if Slice should be highlighted when hovered over for all Slices.

    Returns

    Chart itself

    Parameters

    • state: boolean

      True if Slice should highlight on hover, false if not.

    Returns SlicedCharts<T>

setSliceSorter

  • Set sorter of Slices as a comparator-function.

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

    Returns

    Chart itself

    Parameters

    • sliceSorter: SliceSorter<T>

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

    Returns SlicedCharts<T>

setSliceStrokeStyle

Settings

Member Visibility

Theme