Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LightningChart

Interface for factories of Charting components.

Each property of this interface is a Factory for creating LCJS components. They are functions which all have one parameter (might be optional), which is used to pass options to the created component.

All components are able to handle the options defined by interface: EngineOptions, which can be used to setup the rendering environment for the component. Most importantly this is used to embed the component in a DOM element created by the user.

Index

Properties

Chart3D

Chart3D : function

Factory for Chart3D. This Chart visualizes data in a 3-dimensional scene, with camera and light source(s). Currently supports only Point Series, but more series types will be added later on.

This Factory can be supplied with an options object, which - along with EngineOptions - can also contain properties of Chart3DOptions-interface, which can be used for:

  • Selecting a preset color Theme.

Example usage:

Desired result Usage
Chart3D with default AutoCursor and Axes Chart3D()
Chart3D embedded in a DOM element Chart3D({ container: 'chart_div_id' })
param

Optional options for creation of the Charts rendering engine

returns

Chart3D

ChartXY

ChartXY : function

Factory for ChartXY. This chart visualizes the data using the Cartesian coordinate system. It has a multitude of methods for adding various types of Series.

This Factory can be supplied with an options object, which - along with EngineOptions - can also contain properties of ChartXYOptions-interface, which can be used for:

  • Selecting a preset color Theme.
  • Supplying a custom Builder for the AutoCursor of Chart. This can be used to modify the AutoCursor on a level, which can't be done during runtime. For example, changing the shape of ResultTable Background, Etc.

Example usage:

// ChartXY with default AutoCursor and Axes
ChartXY()
// ChartXY embedded in a DOM element
ChartXY({ container: 'chart_div_id' })

More ChartXY specific examples can be found in documentation of ChartXYOptions.

param

Optional options for creation of Chart and its rendering engine

returns

ChartXY

    • Type parameters

      Parameters

      • options: EngineOptions & ChartXYOptions<CursorPointMarkerType, CursorResultTableBackgroundType, CursorTickMarkerBackgroundTypeX, CursorTickMarkerBackgroundTypeY>

      Returns ChartXY<CursorPointMarkerType, CursorResultTableBackgroundType, CursorTickMarkerBackgroundTypeX, CursorTickMarkerBackgroundTypeY>

Dashboard

Dashboard : function

Factory for Dashboard. Dashboard allows placement of multiple Charts, sharing a common rendering engine between them. It also enables users to resize the cells with mouse/touch interaction.

Example usage:

// Dashboard with 2 columns and 3 rows
Dashboard({ numberOfColumns: 2, numberOfRows: 3 })
// Dashboard embedded in a DOM element
Dashboard({ ..., container: 'dashboard_div_id' })

When creating a Dashboard the Factory MUST be supplied with an object which fulfills the DashboardOptions-interface. This object can also optionally contain properties of EngineOptions.

param

Options for creation of Dashboard and optionally also for its rendering Engine.

returns

Dashboard

Funnel

Funnel : function

Factory for FunnelChart. This chart visualizes proportions and percentages between categories,

This Factory can be supplied with an options object, which - along with EngineOptions - can also contain properties of FunnelChartOptions-interface, which can be used for:

  • Selecting a preset color Theme.
  • Specifying "type" for Funnel Chart.

Example usage:

// Funnel Chart with default type
Funnel()
// Funnel Chart with specified type
Funnel({ type: FunnelChartTypes.LabelsOnSides })
// Funnel Chart embedded in a DOM element
Funnel({ container: 'chart_div_id' })

More FunnelChart specific examples can be found in documentation of FunnelChartOptions.

param

Optional options for creation of Chart and its rendering engine

returns

FunnelChart with type specified via 'options'

Gauge

Gauge : function

Factory for GaugeChart. Gauge charts indicate where your data point(s) falls over a particular range. This chart type is often used in executive dashboard reports to show key business indicators.

This Factory can be supplied with an options object, which - along with EngineOptions - can also contain properties of GaugeChartOptions-interface, which can be used for:

  • Selecting a preset color Theme.
  • Specifying "type" for Gauge Chart.

Example usage:

// Gauge Chart with default type
Gauge()
// Gauge Chart with specified type
Gauge({ type: GaugeChartTypes.Solid })
// Gauge Chart embedded in a DOM element
Gauge({ container: 'chart_div_id' })

More GaugeChart specific examples can be found in documentation of GaugeChartOptions.

param

Optional options for creation of Chart and its rendering engine

returns

GaugeChart with type specified via 'options'

Pie

Pie : function

Factory for PieChart. This chart visualizes proportions and percentages between categories, by dividing a circle into proportional segments.

This Factory can be supplied with an options object, which - along with EngineOptions - can also contain properties of PieChartOptions-interface, which can be used for:

  • Selecting a preset color Theme.
  • Specifying "type" for Pie Chart.

Example usage:

// Pie Chart with default type
Pie()
// Pie Chart with specified type
Pie({ type: PieChartTypes.PieChartWithLabelsOnSides })
// Pie Chart embedded in a DOM element
Pie({ container: 'chart_div_id' })

More PieChart specific examples can be found in documentation of PieChartOptions.

param

Optional options for creation of Chart and its rendering engine

returns

PieChart with type specified via 'options'

Pyramid

Pyramid : function

Factory for PyramidChart. This chart visualizes proportions and percentages between categories,

This Factory can be supplied with an options object, which - along with EngineOptions - can also contain properties of PyramidChartOptions-interface, which can be used for:

  • Selecting a preset color Theme.
  • Specifying "type" for Pyramid Chart.

Example usage:

// Pyramid Chart with default type
Pyramid()
// Pyramid Chart with specified type
Pyramid({ type: PyramidChartTypes.LabelsOnSides })
// Pyramid Chart embedded in a DOM element
Pyramid({ container: 'chart_div_id' })

More PyramidChart specific examples can be found in documentation of PyramidChartOptions.

param

Optional options for creation of Chart and its rendering engine

returns

PyramidChart with type specified by 'options'

Spider

Spider : function

Factory for SpiderChart. This chart visualizes data in a radial form as dissected by named axes.

This Factory can be supplied with an options object, which - along with EngineOptions - can also contain properties of SpiderChartOptions-interface, which can be used for:

  • Selecting a preset color Theme.
  • Supplying a custom Builder for the AutoCursor of Chart. This can be used to modify the AutoCursor on a level, which can't be done during runtime. For example, changing the shape of ResultTable Background, Etc.

Example usage:

// Spider chart with default AutoCursor and Axes
Spider()
// Spider chart embedded in a DOM element
Spider({ container: 'chart_div_id' })

More SpiderChart specific examples can be found in documentation of SpiderChartOptions.

param

Optional options for creation of Chart and its rendering engine

returns

SpiderChart

UIPanel

UIPanel : function

Factory for UIPanel. This component simply allows the anchoring of user-made UIElements.

Can optionally be supplied with an options object that fulfills the EngineOptions-interface. This can be used to setup the rendering environment of the Panel.

Example usage:

// UIPanel
UIPanel()
// UIPanel embedded in a DOM element
UIPanel({ container: 'panel_div_id' })
param

Optional options for creation of Panels rendering engine

returns

UIPanel