Skip to content

Documentation / @ripl/charts / createPackedCircleChart

Function: createPackedCircleChart()

createPackedCircleChart<TData>(target, options): PackedCircleChart<TData>

Defined in: charts/src/charts/packed-circle.ts:425

Factory function that creates a new PackedCircleChart instance.

Type Parameters

Type ParameterDefault type
TDataunknown

Parameters

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

Returns

PackedCircleChart<TData>

Example

ts
createPackedCircleChart(target, {
    data: [
        { name: 'Alpha', size: 40 },
        { name: 'Beta', size: 25 },
        { name: 'Gamma', size: 15 },
    ],
    key: 'name',
    value: 'size',
    label: 'name',
});