Get API reference
get_api_referenceRead-onlyIdempotent
Get the per-class API reference for an amCharts 5 class: the class page plus its settings table (with defaults) and, optionally, its private/read-only settings. It is generated from the library's typings, so it has the exact setting names and default values (e.g. tooltip background cornerRadius, axis tick visible default). Takes a class name in any casing, e.g. 'XYCursor', 'Tooltip', 'PieSeries', 'AxisRendererX'.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| className | Yes | amCharts 5 class name, e.g. 'XYCursor', 'Tooltip', 'PieSeries', 'ColumnSeries', 'AxisRendererX'. Casing/punctuation are ignored. | |
| includePrivate | No | Also include the private (read-only / internal) settings table. Default false. |