Documentation / @ripl/charts / createTreemapChart

Function: createTreemapChart()

createTreemapChart<TData>(target, options): TreemapChart<TData>

Defined in: charts/src/charts/treemap.ts:492

Factory function that creates a new TreemapChart instance.

Type Parameters

Type Parameter	Default type
TData	unknown

Parameters

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

Returns

TreemapChart<TData>

Example

createTreemapChart(target, {
    data: [
        { name: 'Rent', amount: 1200 },
        { name: 'Food', amount: 600 },
        { name: 'Transport', amount: 300 },
    ],
    key: 'name',
    value: 'amount',
    label: 'name',
});