Class KPIComponent

constructor

• new KPIComponent(
      cell: Cell,
      options: Partial<Options>,
      board?: Board,
  ): KPIComponent

  Creates a KPI component in the cell.

  Parameters

  • cell: Cell

    Instance of cell, where component is attached.

  • options: Partial<Options>

    The options for the component.

  • Optionalboard: Board

  Returns KPIComponent

OptionalcaptionElement

Optionalchart

OptionalchartContainer

connectorHandlers

Protecteddimensions

editableOptions

id

OptionalisActive

options

subtitle

Protected OptionalsyncHandlers

type

StaticdefaultChartOptions

{
        chart: {
            type: 'spline',
            zooming: {
                mouseWheel: {
                    enabled: false
                }
            }
        },
        title: {
            text: void 0
        },
        xAxis: {
            visible: false
        },
        yAxis: {
            visible: false,
            title: {
                text: null
            }
        },
        legend: {
            enabled: false
        },
        credits: {
            enabled: false
        },
        tooltip: {
            outside: true
        },
        plotOptions: {
            series: {
                marker: {
                    enabled: false
                }
            }
        }
    }
Copy

StaticdefaultOptions

StaticformulaFunctions

StaticpredefinedSyncConfig

destroy

• destroy(): void

  Destroys the highcharts component.

  Returns void

getDataTable

• getDataTable(connectorId?: string, dataTableKey?: string): DataTable | undefined

  Returns the data table connected to the component by the connectorId and dataTableKey. If both args are undefined, the first data table is returned.

  Parameters

  • OptionalconnectorId: string

    The id of the connector.

  • OptionaldataTableKey: string

    The key of the data table within the connector.

  Returns DataTable | undefined

  The data table, or undefined if no matching handler is found.

getEditableOptions

• getEditableOptions(): Options

  Returns Options

getEditableOptionValue

• getEditableOptionValue(
      propertyPath?: (string | number)[],
  ): string | number | boolean | undefined

  Parameters

  • OptionalpropertyPath: (string | number)[]

  Returns string | number | boolean | undefined

getOptionsOnDrop

• getOptionsOnDrop(sidebar: SidebarPopup): Partial<Options>

  Returns the component's options when it is dropped from the sidebar.

  Parameters

  • sidebar: SidebarPopup

    The sidebar popup.

  Returns Partial<Options>

initConnectors

• initConnectors(): Promise<KPIComponent>

  Initializes connector handlers for the component.

  Returns Promise<KPIComponent>

resize

• resize(width?: string | number | null, height?: string | number | null): this

  Resize the component

  Parameters

  • Optionalwidth: string | number | null

    The width to set the component to. Can be pixels, a percentage string or null. Null will unset the style

  • Optionalheight: string | number | null

    The height to set the component to. Can be pixels, a percentage string or null. Null will unset the style.

  Returns this

ProtectedresizeDynamicContent

• resizeDynamicContent(
      width?: string | number | null,
      height?: string | number | null,
  ): void

  It's a temporary alternative for the resize method. It sets the strict pixel height for the component so that the content can be distributed in the right way, without looping the resizers in the content and container.

  Parameters

  • Optionalwidth: string | number | null

    The width to set the component to.

  • Optionalheight: string | number | null

    The height to set the component to.

  Returns void

resizeTo

• resizeTo(element: HTMLElement): void

  Adjusts size of component to parent's cell size when animation is done.

  Parameters

  • element: HTMLElement

    HTML element that is resized.

  Returns void

setCaption

• setCaption(captionOptions: TextOptionsType): void

  Adds caption at the bottom of component's container.

  Parameters

  • captionOptions: TextOptionsType

    The options for the caption.

  Returns void

setTitle

• setTitle(titleOptions: TextOptionsType): void

  Adds title at the top of component's container.

  Parameters

  • titleOptions: TextOptionsType

    The options for the title.

  Returns void

setValue

• setValue(value?: string | number | undefined): void

  Sets the value that should be displayed in the KPI.

  Parameters

  • value: string | number | undefined = ...

    The value to display in the KPI.

  Returns void

update

• update(options: Partial<Options>, shouldRerender?: boolean): Promise<void>

  Handles updating via options.

  Parameters

  • options: Partial<Options>

    The options to apply.

  • shouldRerender: boolean = true

  Returns Promise<void>