Interface FunnelChartOptions<FunnelChartType>

Interface for readonly configuration of FunnelChart.

Some properties of FunnelChart can only be configured when it is created. These arguments are all optional, and are wrapped in a single object parameter:

 // Example, create chart with specified color theme.
const chart = LightningChart.Funnel({
theme: Themes.light,
})

Watch out! The full set of available readonly configuration parameters depends on if the chart is standalone, or inside a dashboard:

For standalone FunnelChart, more parameters are documented in Funnel.

For dashboard FunnelChart, more parameters are documented in createFunnelChart.

Commonly used properties:

  • type: Specify visual design of funnel chart from a collection of options.
  • FunnelChartOptions.theme: Specify chart color theme.
  • disableAnimations: Convenience flag to disable all animations from chart.

Example usage:

 // Example 1, create funnel chart with default configuration.
const chart = LightningChart.Funnel({})
 // Example 2, create funnel chart with labels inside slices.
const chart = LightningChart.Funnel({
type: FunnelChartTypes.LabelsInsideSlices
})
 // Example 3, create funnel chart with specified color theme.
const chart = LightningChart.Funnel({
theme: Themes.light,
})

Type Parameters

Hierarchy

Properties

disableAnimations?: boolean

Convenience flag that can be used to disable all animations in a component.

type?: FunnelChartType

Interface for specifying desired "type" of Funnel Chart. This can be used to select different rendering approaches, mainly reflecting how Slice Labels are positioned.

Options are located in FunnelChartTypes-collection. If undefined, will default to FunnelChartWithLabelsOnSides.