ApexPainter member
ApexPainter.createChart
Published ApexPainter.createChart method.
lib-next/apex-painter/main.ts (opens in a new tab)Signature
<T extends "pie" | "bar" | "horizontalBar" | "line" | "scatter" | "radar" | "polarArea">(chartType: T, data: T extends "pie" ? PieSlice[] : T extends "bar" ? BarChartData[] : T extends "horizontalBar" ? HorizontalBarChartData[] : T extends "line" ? LineSeries[] : T extends "scatter" ? ScatterSeries[] : T extends "radar" ? RadarSeries[] : T extends "polarArea" ? PolarAreaSlice[] : never, options?: T extends "pie" ? PieChartOptions : T extends "bar" ? BarChartOptions : T extends "horizontalBar" ? HorizontalBarChartOptions : T extends "line" ? LineChartOptions : T extends "scatter" ? ScatterChartOptions : T extends "radar" ? RadarChartOptions : T extends "polarArea" ? PolarAreaChartOptions : never, painterOpts?: PainterAssetRefsOptions) => Promise<Buffer>Parameters
chartType
data
T extends "pie" ? PieSlice[] : T extends "bar" ? BarChartData[] : T extends "horizontalBar" ? HorizontalBarChartData[] : T extends "line" ? LineSeries[] : T extends "scatter" ? ScatterSeries[] : T extends "radar" ? RadarSeries[] : T extends "polarArea" ? PolarAreaSlice[] : never
options?
T extends "pie" ? PieChartOptions : T extends "bar" ? BarChartOptions : T extends "horizontalBar" ? HorizontalBarChartOptions : T extends "line" ? LineChartOptions : T extends "scatter" ? ScatterChartOptions : T extends "radar" ? RadarChartOptions : T extends "polarArea" ? PolarAreaChartOptions : never
painterOpts?
Options
| Option | Type | Contract | Allowed values | Runtime & capabilities |
|---|---|---|---|---|
| painterOpts | ||||
painterOpts.resolveAssetRefsWhen **true**, string leaves in the payload are resolved via {@link AssetManager.resolve } (same rules as {@link ApexPainter.prepareForRender } / {@link ApexPainter.renderScene }). | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
painterOpts.resolveAssetRefs
OptionalWhen **true**, string leaves in the payload are resolved via {@link AssetManager.resolve } (same rules as {@link ApexPainter.prepareForRender } / {@link ApexPainter.renderScene }).
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Types
PainterAssetRefsOptions: PainterAssetRefsOptions
- resolveAssetRefs?
boolean
Return value
Promise<Buffer<ArrayBufferLike>>
The return contract is generated from the packed declaration. Async wrappers and nullable/undefined variants remain visible in the type model.
Errors
NOT APPLICABLE — no verified errors are bound to this API.
Limits
NOT APPLICABLE — no API-specific verified limits are bound to this API.
Related APIs
No explicit related API metadata.