Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PyramidChart

Abstract base class for Pyramid Charts. Visualizes proportions and percentages between categories, by dividing a pyramid into proportional segments.

Set data using PyramidChart.addSlice( name: string, value: number )

There are multiple implementations of PyramidChart, each with their own visual design and API for customizing it. List of selectable options can be found in: PyramidChartTypes

Index

Properties

Readonly engine

engine : PublicEngine

Public, safe interface for Panels rendering engine.

pixelScale

pixelScale : Vec2<Scale>

Scale for panel area in pixels. Margin should be set according to panel margin (currently constant).

uiScale

uiScale : Vec2<Scale>

Scale for panel area in percentages (0-100). Margin should be set according to panel margin (currently constant).

Methods

addLegendBox

  • Add a stand-alone LegendBox using a builder.

    Type parameters

    • UIElementType: UIPart = UILegendBox

      Type of UIElement that is specified by 'builder'-parameter.

    Parameters

    • builder: UIElementBuilder<UIElementType>

      LegendBoxBuilder. If omitted, HorizontalLegendBox will be selected. Use LegendBoxBuilders for selection.

    • scale: Vec2<Scale>

      Optional custom scale to position LegendBox on. Defaults to whole chart in percentages [0, 100].

    Returns UIElementType & UIElement

    LegendBox that fulfills interfaces: UIElementType (typeparam) and UIElement

addSlice

  • This method is used for the adding slices in the pyramid chart.

    Parameters

    • title: string

      Pyramid slice title

    • value: number

      pyramid slice value

    Returns PyramidSlice

addSlices

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

    Parameters

    • slices: object[]

      Array of slices

    Returns Array<PyramidSlice>

addUIElement

  • Add a stand-alone UIElement using a builder.

    Type parameters

    • UIElementType: UIPart = UITextBox

      Type of UIElement that is specified by 'builder'-parameter.

    Parameters

    • builder: UIElementBuilder<UIElementType>

      UIElementBuilder. If omitted, TextBoxBuilder will be selected. Use UIElementBuilders for selection.

    • scale: Vec2<Scale>

      Optional custom scale to position UIElement on. Defaults to whole chart in percentages [0, 100].

    Returns UIElementType & UIElement

    Object that fulfills interfaces: UIElementType (typeparam) and UIElement

disableAnimations

  • disableAnimations(): this
  • Disable all animations for the chart.

    All animations have to be re-enabled individually if you wish to re-enable animations.

    Returns this

    Chart itself for fluent interface.

dispose

  • dispose(): this
  • Permanently dispose the component.

    To fully allow Garbage-Collection to free the resources used by the component, make sure to remove any references to the component and its children in application code.

    let chart = ...Pyramid()
    let slice = chart.addSlice({name: 'name', value: 50})
    // Dispose Chart, and remove all references so that they can be garbage-collected.
    chart.dispose()
    chart = undefined
    slice = undefined

    Returns this

    Object itself for fluent interface

getAnimationsEnabled

  • getAnimationsEnabled(): boolean
  • Gets if animations are enabled or not.

    Returns boolean

    Boolean state for animations enabled

getBackgroundFillStyle

  • Get fillstyle of chart background.

    Returns FillStyle

    FillStyle

getBackgroundStrokeStyle

  • getBackgroundStrokeStyle(): LineStyle
  • Get stroke style of chart background.

    Returns LineStyle

    LineStyle

getLabelFillStyle

getLabelFont

getLabelFormatter

getNeckWidth

  • getNeckWidth(): number
  • Get Pyramid Neck Width

    Returns number

    number (0 - 100)

getPadding

  • Get padding around Chart in pixels.

    Returns Margin

    Padding datastructure

getPyramidSliceMode

  • Get PyramidSliceMode. Can be used to select between different drawing approaches for Slices.

    See PyramidSliceModes for a collection of options.

    Returns PyramidSliceModes

    PyramidSliceMode

getSliceFillStyle

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

    So, for example... We have a Pyramid 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

getSliceStrokeStyle

  • getSliceStrokeStyle(): LineStyle

getSlices

  • Get all Slices of Pyramid Chart. NOTE: Manual modifications to returned Array can have unforeseen side-effects. Removing or adding Slices is intended to be done using other APIs (PyramidChart.addSlice, Slice.dispose, ...)

    Returns PyramidSlice[]

    Array of Slices

getTitle

  • getTitle(): string
  • Get text of Chart title.

    Returns string

    Chart title as a string.

getTitleFillStyle

  • Get fill style of Chart Title.

    Returns FillStyle

    FillStyle object

getTitleFont

  • Get font of Chart title.

    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
  • Remove event listener from resize event.

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

onResize

  • onResize(handler: function): Token
  • Subscribe to resize event of Panel.

    Parameters

    • handler: function

      Handler function for event

        • 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
  • Capture rendered state in an image file. Prompts the browser to download the created file.

    NOTE: The download might be blocked by browser/plugins as harmful. To prevent this, only call the method in events tied to user-interactions. From mouse-event handlers, for example.

    Has two optional parameters which directly reference JavaScript API HTMLCanvasElement.toDataURL. For supported image formats, compression quality, Etc. refer to:

    https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/toDataURL

    Example usage:

    // Download 'screenshot.png'
    Panel.saveToFile('screenshot')
    // Attempt download 'maybeNotSupported.bmp'
    Panel.saveToFile('maybeNotSupported', 'image/bmp')
    // Attempt download jpeg.file with specified compression quality
    Panel.saveToFile('fileName', 'image/jpeg', 0.50)
    sideeffect

    If 'type' is not supported by browser, an Error will be thrown.

    Parameters

    • fileName: string

      Name of prompted download file as string. File extension shouldn't be included as it is automatically detected from 'type'-argument.

    • type: undefined | string

      A DOMString indicating the image format. The default format type is image/png.

    • encoderOptions: undefined | number

      A Number between 0 and 1 indicating the image quality to use for image formats that use lossy compression such as image/jpeg and image/webp. If this argument is anything else, the default value for image quality is used. The default value is 0.92.

    Returns this

setAnimationsEnabled

  • setAnimationsEnabled(animationsEnabled: boolean): this
  • Sets if animations are enabled or not.

    Parameters

    • animationsEnabled: boolean

      Boolean state for animations enabled

    Returns this

    Pyramid Chart itself

setBackgroundFillStyle

setBackgroundStrokeStyle

  • setBackgroundStrokeStyle(value: LineStyle | ImmutableMutator<LineStyle>): this
  • Set stroke style of panel background.

    Parameters

    • value: LineStyle | ImmutableMutator<LineStyle>

      LineStyle or function which modifies it

    Returns this

    Object itself

setLUT

  • setLUT(value: LUT): this
  • Attach lookup table (LUT) to fill the slices with Colors based on value.

    The color for the slice would be selected from a specified LUT, which contains the information about gradient steps. After setting LUT to undefined all the slices stay colorized, but no further lookup.

    LUT class stores information about values and its associated colors,

    • which provides efficient lookup of the color based on provided value
    • as well as linear and step interpolation between colors.
    const pyramid = lightningChart()
     .Pyramid( { type: PyramidChartTypes.LabelsOnSides } )
     .setLUT( new LUT (steps: [
             { value: 10, color: ColorRGBA( 0, 0, 0 ) },
             { value: 20, color: ColorRGBA( 30, 255, 0 ) },
             { value: 30, color: ColorRGBA( 60, 204, 0 ) },
             { value: 40, color: ColorRGBA( 90, 128, 0 ) },
             { value: 50, color: ColorRGBA( 255, 0, 0 ) } ) ],
         interpolate: true } )

    Parameters

    • value: LUT

      Lookup table

    Returns this

    Pyramid itself for fluent interface

setLabelFillStyle

setLabelFont

setLabelFormatter

setNeckWidth

  • setNeckWidth(neckWidth: number): this
  • Set Pyramid Neck Width

    Parameters

    • neckWidth: number

      Pyramid Neck Width range from 0 to 100

    Returns this

    Pyramid Chart itself

setPadding

  • setPadding(padding: Partial<Margin> | number): this
  • Set padding around Chart in pixels.

    Parameters

    • padding: Partial<Margin> | number

      Number with pixel margins for all sides or datastructure with individual pixel paddings for each side. Any side can be omitted, only passed values will be overridden.

    Returns this

    Object itself

setSliceFillStyle

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

    So, for example... We have a Pyramid 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

    Pyramid Chart itself

setSliceGap

  • setSliceGap(sliceGap: pixel): this
  • Set gap between Slice / start of label connector, and end of label connector / Label.

    Parameters

    • sliceGap: pixel

      Gap as pixels. Clamped between [0, 20] !

    Returns this

    Pyramid Chart itself

setSliceHighlightOnHover

  • setSliceHighlightOnHover(state: boolean): this
  • Set if slices should be highlighted on mouse hover / touch. Applies to all Slices.

    Parameters

    • state: boolean

      True if Slices should be highlighted on hover, false if not. This applies to all existing Slices and new Slices added.

    Returns this

setSliceMode

  • Set PyramidSliceMode. Can be used to select between different drawing approaches for Slices.

    See PyramidSliceModes for a collection of options.

    Parameters

    Returns this

    Pyramid Chart itself

setSliceSorter

  • Set sorter of Pyramids' Slices as a comparator-function.

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

    Parameters

    • sliceSorter: SliceSorter<PyramidSlice>

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

    Returns this

    Pyramid Chart itself

setSliceStrokeStyle

  • Set style of Pyramid Slices Stroke.

    Parameters

    • value: LineStyle | ImmutableMutator<LineStyle>

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

    Returns this

    Pyramid Chart itself

setTitle

  • setTitle(title: string): this
  • Set text of Chart title.

    Parameters

    • title: string

      Chart title as a string.

    Returns this

    Object itself for fluent interface.

setTitleFillStyle

  • Set fill style of Chart Title.

    Example usage:

    // Create a new style
    Chart.setTitleFillStyle(new SolidFill({ color: ColorHEX('#F00') }))
    // Change transparency
    Chart.setTitleFillStyle((solidFill) => solidFill.setA(80))
    // Set hidden
    Chart.setTitleFillStyle(emptyFill)

    Parameters

    Returns this

    Chart itself

setTitleFont

  • Set font of Chart Title.

    Example usage:

    // Create a new FontSettings
    Chart.setTitleFont(new FontSettings({ size: 24, style: 'italic' }))
    // Change existing settings
    Chart.setTitleFont((fontSettings) => fontSettings.setWeight('bold'))

    Parameters

    Returns this

    Chart itself

setTitleMarginBottom

  • setTitleMarginBottom(marginPixels: pixel): this
  • Specifies padding after chart title.

    This does not have an effect if title is hidden (empty FillStyle).

    Parameters

    • marginPixels: pixel

      Gap after the chart title in pixels.

    Returns this

    Chart itself for fluent interface

setTitleMarginTop

  • setTitleMarginTop(marginPixels: pixel): this
  • Specifies padding before chart title.

    This does not have an effect if title is hidden (empty FillStyle).

    Parameters

    • marginPixels: pixel

      Gap between the top of chart and its title in pixels.

    Returns this

    Chart itself for fluent interface