Skip to content

Documentation / @ripl/charts / createAreaChart

Function: createAreaChart() ​

createAreaChart<TData>(target, options): AreaChart<TData>

Defined in: charts/src/charts/area.ts:511

Factory function that creates a new AreaChart instance.

Type Parameters ​

Type ParameterDefault type
TDataunknown

Parameters ​

ParameterType
targetstring | HTMLElement | Context<Element, Record<string, unknown>>
optionsAreaChartOptions<TData>

Returns ​

AreaChart<TData>

Example ​

ts
createAreaChart(target, {
    data: [
        { month: 'Jan', visitors: 820 },
        { month: 'Feb', visitors: 932 },
    ],
    key: 'month',
    series: [
        { id: 'visitors', label: 'Visitors', value: 'visitors' },
    ],
});