Documentation / @ripl/charts / createScatterChart

Function: createScatterChart()

createScatterChart<TData>(target, options): ScatterChart<TData>

Defined in: charts/src/charts/scatter.ts:835

Factory function that creates a new ScatterChart instance.

Type Parameters

Type Parameter	Default type
TData	unknown

Parameters

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

Returns

ScatterChart<TData>

Example

createScatterChart(target, {
    data: [
        { id: 'a', weight: 70, height: 175, age: 30 },
        { id: 'b', weight: 85, height: 182, age: 45 },
    ],
    key: 'id',
    series: [{
        id: 'people',
        label: 'People',
        xBy: 'height',
        yBy: 'weight',
        sizeBy: 'age',
    }],
});