Documentation / @ripl/charts / createArcDiagramChart

Function: createArcDiagramChart()

createArcDiagramChart<TData>(target, options): ArcDiagramChart<TData>

Defined in: charts/src/charts/arc-diagram.ts:738

Factory function that creates a new ArcDiagramChart instance.

Type Parameters

Type Parameter	Default type
TData	unknown

Parameters

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

Returns

ArcDiagramChart<TData>

Example

createArcDiagramChart(target, {
    nodes: [
        { id: 'a', label: 'Alice' },
        { id: 'b', label: 'Bob' },
        { id: 'c', label: 'Carol' },
    ],
    links: [
        { source: 'a', target: 'b', value: 3 },
        { source: 'b', target: 'c', value: 1 },
    ],
});