Skip to content

Documentation / @ripl/charts / createPolarScatterChart

Function: createPolarScatterChart() ​

createPolarScatterChart<TData>(target, options): PolarScatterChart<TData>

Defined in: charts/src/charts/polar-scatter.ts:673

Factory function that creates a new PolarScatterChart instance.

Type Parameters ​

Type ParameterDefault type
TDataunknown

Parameters ​

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

Returns ​

PolarScatterChart<TData>

Example ​

ts
createPolarScatterChart(target, {
    data: [
        { bearing: 30, distance: 12, magnitude: 4 },
        { bearing: 120, distance: 26, magnitude: 8 },
    ],
    series: [{
        id: 'readings',
        label: 'Readings',
        angleBy: 'bearing',
        radiusBy: 'distance',
        sizeBy: 'magnitude',
    }],
});