Interface FunnelOptions<FunnelChartType>

Interface that can be used to define FunnelChart configurations, when inside a Dashboard, that can't be changed after creation.

Example usage:

// Funnel Chart with default type
undefined
// Funnel Chart with specified type
{ funnelOptions: { type: FunnelChartTypes.LabelsOnSides } }

Type Parameters

Hierarchy

Properties

animationsEnabled? autoCursorBuilder? columnIndex columnSpan? disableAnimations? rowIndex rowSpan? type?

Properties

Optional animationsEnabled

animationsEnabled?: boolean

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

Optional Readonly autoCursorBuilder

autoCursorBuilder?: AutoCursor2DBuilder<UIBackground>

Builder for the charts' auto cursor.

For most use cases, it is not recommended to use this, but rather setAutoCursor for a more convenient API.

columnIndex

columnIndex: number

Column index on dashboard (X location, 0 = left)

Optional columnSpan

columnSpan?: number

Column span (X width), default = 1

Optional disableAnimations

disableAnimations?: boolean

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

Deprecated

Deprecated in v5.0.0. Use animationsEnabled instead (note that value should be inverted from previous applications!)

rowIndex

rowIndex: number

Row index on dashboard (Y location, 0 = top)

Optional rowSpan

rowSpan?: number

Row span (Y height), default = 1

Optional type

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.

Settings

Member Visibility

Theme