Documentation / @ripl/charts / createFunnelChart

Function: createFunnelChart()

createFunnelChart<TData>(target, options): FunnelChart<TData>

Defined in: charts/src/charts/funnel.ts:401

Factory function that creates a new FunnelChart instance.

Type Parameters

Type Parameter	Default type
TData	unknown

Parameters

Parameter	Type
target	string | HTMLElement | Context<Element, Record<string, unknown>>
options	FunnelChartOptions<TData>

Returns

FunnelChart<TData>

Example

createFunnelChart(target, {
    data: [
        { stage: 'Visited', users: 1000 },
        { stage: 'Signed up', users: 420 },
        { stage: 'Purchased', users: 130 },
    ],
    key: 'stage',
    label: 'stage',
    value: 'users',
});