Chart API reference.
All properties, events, and methods of the shared sy-chart facade.
sy-chart
#The full public API for sy-chart. Pass objects and arrays as JavaScript properties. Select a name to view usage code and type definitions.
Key properties
| Attribute / Property | Type / Default | Description |
|---|---|---|
ChartTypeDefault: 'line' | Chart type. The selected type's license and module requirements apply. | |
| brandLogo | stringDefault: undefined | The default is the Syidax logo. With the Pro chart.branding entitlement, use none or a PNG, JPEG, or WebP data URL. |
| brandPosition | 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'Default: 'bottom-right' | The corner where the logo is anchored. Applies equally to Community and Pro, on screen and in image exports. |
LineChartSeries[] | ScatterChartSeries[]Default: undefined | An array of series with names, colors, and values. Matching indices represent the same point in time. | |
numberDefault: 600 | Chart width in pixels. Update with ResizeObserver when the container changes. | |
numberDefault: 300 | Chart height in pixels. | |
| xAxis | CartesianAxisInput | ReadonlyArray<CartesianAxisInput>Default: undefined | Match category axis categories to the values order. |
| yAxis | CartesianAxisInputDefault: undefined | Use consistent units and ranges for values being compared. |
Other properties 487
| Attribute / Property | Type / Default | Description |
|---|---|---|
| typeLoadTimeout | numberDefault: 30_000 | Budget (ms) for the chart type's element to become ready once it is rendered (ROADMAP-loading §7.2): a lazy chunk that never arrives turns into the load-failed notice (reason `timeout`) with a Retry control. 0 or less = no limit. |
| activeSeriesIndex | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| seriesState | LineChartSeriesStateOptionsDefault: undefined | Pass as a JavaScript property. type: LineChartSeriesStateOptions. |
LineChartValues | ScatterChartValuesDefault: new Float32Array(0) | Pass as a JavaScript property. type: LineChartValues | ScatterChartValues. | |
string | ReadonlyArray<string>Default: '#2563eb' | Pass as a JavaScript property. type: string | ReadonlyArray<string>. | |
numberDefault: 1 | Set as an HTML attribute or JavaScript property. type: number. | |
LineChartMarker | ScatterChartMarkerSymbol | string | ReadonlyArray<string>Default: 'none' | Pass as a JavaScript property. type: LineChartMarker | ScatterChartMarkerSymbol | string | ReadonlyArray<string>. | |
| markerSize | numberDefault: 4 | Set as an HTML attribute or JavaScript property. type: number. |
| markerLineWidth | numberDefault: 0 | Set as an HTML attribute or JavaScript property. type: number. |
| hitTolerance | numberDefault: 8 | Set as an HTML attribute or JavaScript property. type: number. |
| markerFilter | LineChartMarkerFilterDefault: undefined | Pass as a JavaScript property. type: LineChartMarkerFilter. |
| markerClickable | booleanDefault: true | Set as an HTML attribute or JavaScript property. type: boolean. |
| markerActiveTrigger | LineChartMarkerActiveTriggerDefault: 'hover' | Allowed values: hover, click, custom. Default: 'hover'. |
| seriesActiveTrigger | LineChartMarkerActiveTriggerDefault: undefined | Allowed values: hover, click, custom. Default: undefined. |
| lineDash | number[]Default: [] | Pass as a JavaScript property. type: number[]. |
| connectNulls | booleanDefault: false | Set as an HTML attribute or JavaScript property. type: boolean. |
LineChartSmoothDefault: 'none' | Allowed values: none, monotone, cardinal. Default: 'none'. | |
| smoothTension | numberDefault: 0.5 | Set as an HTML attribute or JavaScript property. type: number. |
LineChartStepDefault: 'none' | Allowed values: none, left, right, center. Default: 'none'. | |
LineChartEngineModeDefault: 'auto' | Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type. | |
| proThreshold | numberDefault: 100_000 | Set as an HTML attribute or JavaScript property. type: number. |
LineChartUnavailableBehaviourDefault: 'fallback' | Allowed values: fallback, error. Default: 'fallback'. | |
| streamSource | ChartStreamSourceDefault: undefined | A stream source for live data. Check the contract for the specific type. |
| streamWindow | numberDefault: undefined | The streaming data range to keep visible. |
| streamMax | numberDefault: undefined | The maximum number of streaming data points to retain. |
| frameBudget | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| streamWindowMs | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| streamTimestamps | 'on' | 'off'Default: undefined | Allowed values: off, on. Default: undefined. |
| animated | booleanDefault: false | Whether to animate initial display and data changes. |
| animationDuration | numberDefault: 200 | Animation duration in milliseconds. |
| animationEasing | LineChartEasingDefault: 'ease-out' | Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'. |
| animationType | ChartAnimationTypeDefault: undefined | Allowed values: initial, update. Default: undefined. |
booleanDefault: undefined | Whether to show a legend for series or items. | |
| legendPosition | LineChartLegendPositionDefault: 'bottom' | Where the legend is positioned. |
| legendItems | LegendItem[]Default: undefined | Pass as a JavaScript property. type: LegendItem[]. |
| seriesName | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
| legendFloatAlign | 'start' | 'center' | 'end'Default: 'end' | Allowed values: start, center, end. Default: 'end'. |
| legendFloatVerticalAlign | 'top' | 'middle' | 'bottom'Default: 'top' | Allowed values: top, bottom, middle. Default: 'top'. |
| legendDraggable | booleanDefault: false | Set as an HTML attribute or JavaScript property. type: boolean. |
| fillColor | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
| fillOpacity | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| fillGradient | unknownDefault: undefined | Pass as a JavaScript property. type: unknown. |
| fillPattern | unknownDefault: undefined | Pass as a JavaScript property. type: unknown. |
| patternKind | AreaChartPatternKindDefault: undefined | Allowed values: dots, diagonal, cross-hatch, diagonal-forward, diagonal-backward, fill. Default: undefined. |
| patternColor | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
| patternBackground | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
| patternSize | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| patternThickness | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| barPadding | numberDefault: 0.1 | Set as an HTML attribute or JavaScript property. type: number. |
| seriesPadding | numberDefault: 0.1 | Set as an HTML attribute or JavaScript property. type: number. |
numberDefault: 0 | Reference value for cartesian charts. Column / bar / area use it as the visual anchor; line uses it as a value-axis reference marker. Always explicit (default `0`) so the baseline stays visible regardless of `type`. | |
CartesianSeriesStackingModeDefault: undefined | Allowed values: normal, percent. Default: undefined. | |
| borderRadius | CartesianSeriesCornerRadiusValueDefault: undefined | Pass as a JavaScript property. type: CartesianSeriesCornerRadiusValue. |
| borderScope | 'point' | 'stack' | 'outline'Default: undefined | Allowed values: point, stack, outline. Default: undefined. |
| borderColor | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
| borderWidth | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| borderDashStyle | CartesianSeriesBorderDashStyleDefault: undefined | Allowed values: Solid, Dash, Dot, DashDot, LongDash, LongDashDot. Default: undefined. |
| inactiveOtherPoints | booleanDefault: false | Set as an HTML attribute or JavaScript property. type: boolean. |
| inactivePointOpacity | numberDefault: 0.2 | Set as an HTML attribute or JavaScript property. type: number. |
Dataset | DatasetSourceInput | ReadonlyArray<DatasetRow> | nullDefault: undefined | Pass as a JavaScript property. type: Dataset | DatasetSourceInput | ReadonlyArray<DatasetRow> | null. | |
| sourceTransforms | ReadonlyArray<DatasetTransform>Default: undefined | Pass as a JavaScript property. type: ReadonlyArray<DatasetTransform>. |
DatasetEncode | ReadonlyArray<DatasetEncode>Default: undefined | Pass as a JavaScript property. type: DatasetEncode | ReadonlyArray<DatasetEncode>. | |
number | booleanDefault: undefined | Pass as a JavaScript property. type: number | boolean. | |
| progressiveThreshold | numberDefault: 20000 | Set as an HTML attribute or JavaScript property. type: number. |
| chartTitle | stringDefault: undefined | The title inside the chart. Explain the data's unit and meaning alongside it. |
| chartSubtitle | stringDefault: undefined | The subtitle inside the chart. |
CartesianTooltipInput | PieChartTooltipInput | GaugeChartTooltipInput | RadarChartTooltipInput | FunnelChartTooltipInputDefault: undefined | Tooltip settings for pointer-driven values, position, and content. | |
CartesianCrosshairInputDefault: undefined | Bare crosshair or {} enables defaults. Object props and JSON attributes override options. Omit/remove the attribute to disable. | |
| gridLines | CartesianGridLinesInputDefault: undefined | Allowed values: auto, off. Default: undefined. |
CartesianZoomInputDefault: undefined | Settings for zooming and the visible range. | |
CartesianBrushInputDefault: undefined | Allowed values: auto, off, true, false, rect, lasso. Default: undefined. | |
ChartDrawingsInputDefault: undefined | Pass as a JavaScript property. type: ChartDrawingsInput. | |
| drawingMode | DrawingModeInputDefault: undefined | Allowed values: none, off, true, false, draw, select. Default: undefined. |
| drawingTool | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
| drawingSpace | DrawingSpaceDefault: undefined | Allowed values: data, pixel. Default: undefined. |
| visualMap | VisualMapBinding | nullDefault: undefined | Pass as a JavaScript property. type: VisualMapBinding | null. |
| xLabelMode | 'auto' | 'all' | 'thin' | 'rotate' | 'none'Default: undefined | How crowded category-axis labels are decluttered. `'auto'` (default) keeps labels horizontal and thins any that would collide. `'all'` shows everything, `'thin'`/`'rotate'` force one strategy, `'none'` hides the labels. |
| xLabelRotation | numberDefault: undefined | Explicit category-label rotation in degrees (respected as a floor on top of auto-declutter). |
| xLabelMaxCount | numberDefault: undefined | Hard cap on the number of category-axis labels shown (kept evenly spaced). |
| innerSize | number | stringDefault: undefined | Pass as a JavaScript property. type: number | string. |
| startAngleProp | numberDefault: undefined | Pie/gauge/item start angle; Chord uses degrees with a default of -90 (top). |
| endAngleProp | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| centerText | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
| centerSubtext | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
| slicedOffset | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
PieChartPaletteNameDefault: undefined | Allowed values: tableau10, tableau20, observable10, paired12, set3_12. Default: undefined. | |
ReadonlyArray<string>Default: undefined | Pass as a JavaScript property. type: ReadonlyArray<string>. | |
| labelsMode | PieChartLabelModeDefault: undefined | Allowed values: none, auto, inside, outside. Default: undefined. |
| labelsContent | PieChartLabelContentDefault: undefined | Allowed values: percent, value, name, name-percent, name-value. Default: undefined. |
| labelsDistance | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| labelsFontSize | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| labelsMinSweep | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| labelsConnector | booleanDefault: undefined | Set as an HTML attribute or JavaScript property. type: boolean. |
| allowSelect | booleanDefault: undefined | Set as an HTML attribute or JavaScript property. type: boolean. |
| inactiveOtherSlices | booleanDefault: undefined | Set as an HTML attribute or JavaScript property. type: boolean. |
| inactiveSliceOpacity | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| activeSliceIndex | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| labelsFontWeight | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| labelsColor | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
| labelsConnectorColor | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
| labelsConnectorWidth | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| labelsConnectorPadding | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| labelsConnectorShape | 'crooked' | 'straight'Default: undefined | Allowed values: straight, crooked. Default: undefined. |
| labelsAllowOverlap | booleanDefault: undefined | Set as an HTML attribute or JavaScript property. type: boolean. |
| tooltipEnabled | booleanDefault: undefined | Pie tooltip toggle. Named `tooltipEnabled` to avoid the cartesian `tooltipShow` event. |
| tooltipFormat | ((slice: PieChartResolvedSlice) => string) | ((detail: ChordHitDetail) => string) | ((detail: NetworkGraphHitDetail) => string) | ((detail: TreemapHitDetail) => string) | ((detail: SunburstHitDetail) => string) | ((detail: IcicleHitDetail) => string) | ((detail: GanttHitDetail) => string) | ((detail: ParallelCoordinatesHitDetail) => string) | ((detail: DendrogramHitDetail) => string) | ((detail: GeoMapHitDetail) => string)Default: undefined | Pie tooltip HTML formatter (property-only — functions can't be set via attribute). |
| enableMouseTracking | booleanDefault: undefined | Pie mouse-tracking toggle. Mirrors Highcharts plotOptions.pie.enableMouseTracking. |
| stickyTracking | booleanDefault: undefined | Keep hover/tooltip until another slice is entered (Highcharts stickyTracking). |
number | stringDefault: undefined | Pie outer diameter. Number = px; '%' = fraction of the smaller plot side. | |
| centerX | number | stringDefault: undefined | Pass as a JavaScript property. type: number | string. |
| centerY | number | stringDefault: undefined | Pass as a JavaScript property. type: number | string. |
| minSize | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| donutThickness | numberDefault: undefined | Donut ring thickness in px. Named `donutThickness` to avoid the cartesian `thickness` prop. |
ItemChartSymbolDefault: undefined | Item dot symbol — `circle` (default) / `square` / `diamond`; per-datum `symbol` overrides. | |
numberDefault: undefined | Item concentric ring count; auto (smallest that fits) when unset. | |
| itemPadding | numberDefault: undefined | Item cell whitespace fraction around each dot, 0..0.9 (Highcharts itemPadding). |
| minFontSize | numberDefault: undefined | Word cloud: smallest rendered font in px (Highcharts minFontSize). |
| maxFontSize | numberDefault: undefined | Word cloud: font px of the heaviest word (Highcharts maxFontSize). |
| weightScale | WordCloudWeightScaleDefault: undefined | Word cloud: weight→fontSize curve — `linear` (default) / `sqrt` / `log`. |
WordCloudSpiralDefault: undefined | Word cloud: spiral search pattern — `rectangular` (default) / `archimedean`. | |
numberDefault: undefined | Word cloud: number of distinct orientations in the rotation cycle (default 2). | |
| rotationFrom | numberDefault: undefined | Word cloud: rotation cycle start in degrees (default 0). |
| rotationTo | numberDefault: undefined | Word cloud: rotation cycle end in degrees (default 90). |
| wordPadding | numberDefault: undefined | Word cloud: empty px kept between word boxes (default 2). |
ReadonlyArray<string>Default: undefined | Pictorial: SVG path definitions the icons cycle through per category. Property-only. | |
| iconPadding | numberDefault: undefined | Pictorial: fraction of each band kept as whitespace around its icon, 0..0.9. |
| trackOpacity | numberDefault: undefined | Pictorial: opacity of the unfilled remainder silhouette (0 hides the track). |
| tileShape | TilemapTileShapeDefault: undefined | Allowed values: circle, square, diamond, hexagon. Default: undefined. |
| showLabels | booleanDefault: undefined | Tilemap: render each tile's label inside the tile when it fits. |
| labelColor | stringDefault: undefined | Tilemap: in-tile label colour. |
| colorAxis | TilemapColorAxisInputDefault: undefined | Tilemap: value→colour axis (`true`/`'auto'`/object). Property-only; off by default. |
| colorLegend | booleanDefault: undefined | Tilemap: show the colour-axis gradient legend (on while the axis is on). |
HeatmapMatrixInputDefault: undefined | Heatmap: a dense matrix — `{ columns, rows, values }` (row-major) or rows of columns. Property-only. | |
| xCategories | HeatmapCategoriesInputDefault: undefined | Heatmap: column labels (array, or a comma list). Given explicitly, they fix the column count. |
| yCategories | HeatmapCategoriesInputDefault: undefined | Heatmap: row labels (row 0 is the top row). |
| emptyColor | stringDefault: undefined | Heatmap: the colour of an empty cell (default transparent). |
numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. | |
| headerHeight | numberDefault: undefined | Treemap branch header band in CSS pixels. |
booleanDefault: false | Enable Treemap branch navigation and accessible hierarchy controls. | |
| dendrogramDirection | DendrogramDirectionDefault: 'left-right' | Dendrogram depth direction; sibling order remains in normalized input order. |
| icicleDirection | IcicleDirectionDefault: 'top-down' | Icicle depth direction; sibling order remains in normalized input order. |
| parallelCoordinatesAxes | ParallelCoordinatesAxesInputDefault: undefined | Independent axis ticks, captions, local guides and label styles. |
| parallelCoordinatesBrush | ParallelCoordinatesBrushInputDefault: undefined | Pass as a JavaScript property. type: ParallelCoordinatesBrushInput. |
| parallelCoordinatesDimensions | ReadonlyArray<ParallelCoordinatesDimensionInput>Default: undefined | Numeric dimensions in display order. Omit to infer them from row values. |
| parallelCoordinatesLineWidth | numberDefault: 1.5 | Set as an HTML attribute or JavaScript property. type: number. |
| parallelCoordinatesLineOpacity | numberDefault: .65 | Set as an HTML attribute or JavaScript property. type: number. |
| parallelCoordinatesInactiveRowOpacity | numberDefault: .25 | Set as an HTML attribute or JavaScript property. type: number. |
| parallelCoordinatesAxisLabels | booleanDefault: true | Set as an HTML attribute or JavaScript property. type: boolean. |
Scene3DCameraOptions|stringDefault: undefined | Camera and orbit settings shared by the 3D families. Assign objects as properties or JSON attributes. | |
Orbit3DOptions|boolean|stringDefault: undefined | Pass as a JavaScript property. type: Orbit3DOptions|boolean|string. | |
Scene3DLightingOptionsDefault: undefined | Pass as a JavaScript property. type: Scene3DLightingOptions. | |
Scene3DMaterialOptionsDefault: undefined | Pass as a JavaScript property. type: Scene3DMaterialOptions. | |
| flowLinesStyle | FlowLinesStyleDefault: undefined | FlowLines route widths, colors, arrows and endpoint markers. |
| flowLinesPath | GeoMapConnectionPathDefault: 'great-circle' | Allowed values: great-circle, straight. Default: 'great-circle'. |
| flowLinesLocationLabels | GeoMapLabelModeDefault: 'auto' | Allowed values: auto, show, hide. Default: 'auto'. |
| flowLinesLabels | GeoMapLabelModeDefault: 'hide' | Allowed values: auto, show, hide. Default: 'hide'. |
| flowLinesLabelValue | booleanDefault: false | Set as an HTML attribute or JavaScript property. type: boolean. |
| themeRiverAxes | ThemeRiverAxesOptionsDefault: undefined | ThemeRiver time and stacked-magnitude axes. |
| themeRiverOffset | ThemeRiverOffsetDefault: 'silhouette' | Allowed values: silhouette, zero, expand. Default: 'silhouette'. |
| themeRiverOrder | ThemeRiverOrderDefault: 'input' | Allowed values: input, reverse. Default: 'input'. |
| themeRiverColors | ReadonlyArray<string>Default: undefined | Pass as a JavaScript property. type: ReadonlyArray<string>. |
| themeRiverOpacity | numberDefault: 1 | Set as an HTML attribute or JavaScript property. type: number. |
| themeRiverHiddenSeries | ReadonlyArray<ThemeRiverId>Default: [] | Pass as a JavaScript property. type: ReadonlyArray<ThemeRiverId>. |
| bar3dAxes | Bar3DAxesOptions|boolean|stringDefault: undefined | Pass as a JavaScript property. type: Bar3DAxesOptions|boolean|string. |
| scatter3dAxes | Scatter3DAxesOptions|boolean|stringDefault: undefined | Pass as a JavaScript property. type: Scatter3DAxesOptions|boolean|string. |
| bar3dSize | Scene3DVectorDefault: undefined | Pass as a JavaScript property. type: Scene3DVector. |
| scatter3dSize | Scene3DVectorDefault: undefined | Pass as a JavaScript property. type: Scene3DVector. |
| bar3dColors | HeatmapColorInputDefault: undefined | Pass as a JavaScript property. type: HeatmapColorInput. |
| scatter3dColors | HeatmapColorInputDefault: undefined | Pass as a JavaScript property. type: HeatmapColorInput. |
| bar3dColorDomain | Bar3DDomainDefault: undefined | Pass as a JavaScript property. type: Bar3DDomain. |
| scatter3dColorDomain | Scatter3DDomainDefault: undefined | Pass as a JavaScript property. type: Scatter3DDomain. |
| bar3dMissingColor | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
| scatter3dMissingColor | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
| bar3dOpacity | numberDefault: 1 | Set as an HTML attribute or JavaScript property. type: number. |
| bar3dWidth | numberDefault: .72 | Set as an HTML attribute or JavaScript property. type: number. |
| bar3dDepth | numberDefault: .72 | Set as an HTML attribute or JavaScript property. type: number. |
| bar3dXCategories | ReadonlyArray<Bar3DCategory>Default: undefined | Pass as a JavaScript property. type: ReadonlyArray<Bar3DCategory>. |
| bar3dYCategories | ReadonlyArray<Bar3DCategory>Default: undefined | Pass as a JavaScript property. type: ReadonlyArray<Bar3DCategory>. |
| scatter3dOpacity | numberDefault: 1 | Set as an HTML attribute or JavaScript property. type: number. |
| scatter3dMarker | Scatter3DMarkerDefault: 'sphere' | Allowed values: sphere, cube. Default: 'sphere'. |
| scatter3dMarkerRadius | numberDefault: .06 | Set as an HTML attribute or JavaScript property. type: number. |
| scatter3dMarkerDetail | 0|1|2Default: 1 | Set as an HTML attribute or JavaScript property. type: 0|1|2. |
| surface3dAxes | Surface3DAxesOptions|boolean|stringDefault: undefined | Pass as a JavaScript property. type: Surface3DAxesOptions|boolean|string. |
| surface3dSize | Scene3DVectorDefault: undefined | Pass as a JavaScript property. type: Scene3DVector. |
| surface3dColors | HeatmapColorInputDefault: undefined | Pass as a JavaScript property. type: HeatmapColorInput. |
| surface3dColorDomain | Surface3DDomainDefault: undefined | Pass as a JavaScript property. type: Surface3DDomain. |
| surface3dMissingColor | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
| surface3dOpacity | numberDefault: 1 | Set as an HTML attribute or JavaScript property. type: number. |
| surface3dWireframe | booleanDefault: false | Set as an HTML attribute or JavaScript property. type: boolean. |
| surface3dWireWidth | numberDefault: .8 | Set as an HTML attribute or JavaScript property. type: number. |
| surface3dWireColor | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
| ganttBarHeight | numberDefault: 24 | Maximum Gantt task bar height in CSS pixels. |
| ganttRowGap | numberDefault: 4 | Gantt row gap in CSS pixels. |
| ganttTimeDomain | readonly [number, number]Default: undefined | Explicit full Gantt time domain in epoch milliseconds. |
| ganttCriticalPath | GanttCriticalPathInputDefault: undefined | Pass as a JavaScript property. type: GanttCriticalPathInput. |
| ganttTaskEditing | GanttTaskEditingInputDefault: undefined | Gantt task move/resize with elapsed-time snapping and optional bounds. Disabled by default. |
| ganttBaseline | GanttBaselineStyleInputDefault: undefined | Gantt reference-date strips and automatic domain inclusion. Visible by default when supplied. |
| ganttDependencies | ReadonlyArray<GanttDependencyInput>Default: undefined | Pass as a JavaScript property. type: ReadonlyArray<GanttDependencyInput>. |
| ganttDependencyStyle | GanttDependencyStyleInputDefault: undefined | Pass as a JavaScript property. type: GanttDependencyStyleInput. |
| ganttTimeAxis | GanttTimeAxisInputDefault: undefined | Pass as a JavaScript property. type: GanttTimeAxisInput. |
| ganttCrosshairTimeUnit | GanttCrosshairTimeUnitDefault: 'hour' | Gantt crosshair time badge precision; default hour. Uses ganttTimeAxis.utc. |
| ganttBarRadius | numberDefault: 3 | Set as an HTML attribute or JavaScript property. type: number. |
| ganttProgressShow | booleanDefault: true | Set as an HTML attribute or JavaScript property. type: boolean. |
| ganttProgressColor | stringDefault: 'auto' | Set as an HTML attribute or JavaScript property. type: string. |
| taskLabelFormat | (task:GanttTask)=>stringDefault: undefined | Pass as a JavaScript property. type: (task:GanttTask)=>string. |
| taskLabels | GanttLabelModeDefault: undefined | Allowed values: auto, show, hide. Default: undefined. |
DensityMapKernelDefault: undefined | Density map: the kernel profile (`gaussian`, `epanechnikov`, `quartic`, `triangular`, `uniform`). | |
DensityMapBandwidthInputDefault: undefined | Density map: the bandwidth — a number (both axes), `"x,y"`, `{ x, y }`, or `auto` (Silverman's rule). | |
| bandwidthUnit | DensityMapBandwidthUnitDefault: undefined | Density map: the unit of an explicit bandwidth — `data` (default) or `px`. |
| cellSize | numberDefault: undefined | Density map: CSS px per estimate cell (the grid follows the plot). |
numberDefault: undefined | Density map: cells under this fraction of the peak density are empty. | |
| computePath | DensityMapComputePathInputDefault: undefined | Density map: where the estimate runs — `auto` (the GPU once the renderer is up), `cpu`, `gpu`. |
numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. | |
| densityUnit | DensityMapUnitInputDefault: undefined | Allowed values: mass, per-area. Default: undefined. |
| sampleRate | numberDefault: undefined | Spectrogram: the sampling rate in Hz — the frequency axis spans 0 … sample-rate / 2. |
| freqMin | numberDefault: undefined | Spectrogram: the frequency axis ends in Hz (they win over `sample-rate`). |
| freqMax | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| hopSeconds | numberDefault: undefined | Spectrogram: seconds per frame (the hop) — the time axis. |
| timeOrigin | numberDefault: undefined | Spectrogram: seconds at the first frame. |
| valueScale | SpectrogramValueScaleDefault: undefined | Spectrogram: `db` (the frames are decibels) or `linear` (magnitudes, converted with 20 · log10). |
| dbFloor | numberDefault: undefined | Spectrogram: the dB a zero magnitude reads on the linear scale (default −120). |
numberDefault: undefined | Calendar heatmap: the year (Jan 1 … Dec 31) unless `start-date` / `end-date` say otherwise. | |
| startDate | stringDefault: undefined | Calendar heatmap: the range ends (ISO dates); they win over `year`; neither → the entries' span. |
| endDate | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
| weekStart | CalendarWeekStartDefault: undefined | Calendar heatmap: the first day of the week (the top row) — `monday` or `sunday`. |
CalendarAggregateDefault: undefined | Calendar heatmap: how several entries on one day fold — `sum`, `max`, `min`, `mean`, `last`. | |
| noDataValue | number | 'nan'Default: undefined | Calendar heatmap: what a day without entries reads — a number (default 0 → the ramp's first colour) or `nan` (→ `empty-color`). |
| monthLabels | booleanDefault: undefined | Calendar heatmap: month labels along the top. |
| weekdayLabels | CalendarWeekdayLabelsDefault: undefined | Calendar heatmap: weekday labels down the left — `short` (rows 0 / 2 / 4), `all`, `none`. |
| monthLines | booleanDefault: undefined | Calendar heatmap: month boundaries as step lines between the cells. |
| upColor | stringDefault: undefined | Candlestick: the colour of a rising bar (close > open). |
| downColor | stringDefault: undefined | Candlestick: the colour of a falling bar (close < open). |
| flatColor | stringDefault: undefined | Candlestick: the colour of a doji (close = open). |
| candleWidth | numberDefault: undefined | Candlestick: the body's share of the bar pitch (0 … 1, default 0.7). |
| wickWidth | numberDefault: undefined | Candlestick: the wick width in CSS px. |
| bodyStyle | CandlestickBodyStyleDefault: undefined | Allowed values: solid, hollow, hollow-up. Default: undefined. |
| wickColor | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
| timeScale | CandlestickTimeScaleDefault: undefined | Allowed values: linear, ordinal. Default: undefined. |
CandlestickSessionInput | stringDefault: undefined | Pass as a JavaScript property. type: CandlestickSessionInput | string. | |
CandlestickVolumeModeDefault: undefined | Allowed values: off, pane. Default: undefined. | |
| volumeHeight | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| volumeUpColor | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
| volumeDownColor | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
| volumeAlpha | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| barStyle | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
CandlestickOverlayInput | stringDefault: undefined | Pass as a JavaScript property. type: CandlestickOverlayInput | string. | |
| boxColor | stringDefault: undefined | Box plot: the box colour — the border, and at `box-fill-alpha` the fill; `auto` whiskers / outliers follow it. |
| boxFillAlpha | numberDefault: undefined | Box plot: the fill's alpha (default 0.35). |
| medianColor | stringDefault: undefined | Box plot: the median line colour. |
| whiskerColor | stringDefault: undefined | Box plot: the whisker / outlier colours (`auto` = the box colour). |
| outlierColor | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
| boxWidth | numberDefault: undefined | Box plot: the box's share of the slot pitch (0 … 1, default 0.6). |
| whiskerRule | stringDefault: undefined | Box plot: `tukey` (1.5 × IQR, the default), `min-max` (no outliers), or a number of IQRs. |
| quantileMethod | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
| whiskerPercentile | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
booleanDefault: undefined | Set as an HTML attribute or JavaScript property. type: boolean. | |
| showMean | booleanDefault: undefined | Set as an HTML attribute or JavaScript property. type: boolean. |
| meanColor | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
| capWidth | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| whiskerWidth | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| medianWidth | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| outlierRadius | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| boxMinPx | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| boxMaxPx | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| notchWidth | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| meanSize | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| fillAlpha | numberDefault: undefined | The fill opacity of a bubble (the border stays opaque). |
| minRadius | numberDefault: undefined | The radius range in CSS px the z range maps onto. |
| maxRadius | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| sizeScale | stringDefault: undefined | `area` (the disc area proportional to z; the default) or `radius`. |
stringDefault: undefined | Bubble: `xy` or `pack`. Network Graph: deterministic `circular`, `force`, or top-to-bottom `hierarchical` placement. | |
stringDefault: undefined | Network Graph: `none` or `louvain` community detection over the current graph; with the automatic palette, node colours follow the group. Independent of `layout`. | |
stringDefault: undefined | Network Graph: `none` or `force` edge bundling of the connecting lines toward compatible neighbours; `bundle-strength` 0 … 1 scales the attraction (default 0.5). | |
| bundleStrength | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| nodeDrag | booleanDefault: undefined | Network Graph — nodes can be dragged with a pointer and nudged with Ctrl / ⌘ + arrows; a dragged node stays pinned. `node-drag="false"` turns it off. |
| packPadding | numberDefault: undefined | Bubble pack gap in CSS px, and `contain` (shrink only) or `fill` fitting. |
| packFit | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. | |
| shadeStrength | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| totalColor | stringDefault: undefined | Waterfall: the subtotal / total bars' colour, the connectors' colour and thickness, their switch. |
| connectorColor | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
| connectorWidth | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| showConnectors | booleanDefault: undefined | Set as an HTML attribute or JavaScript property. type: boolean. |
| barWidth | numberDefault: undefined | Waterfall: the bar's share of the slot pitch (0.6), clamped between bar-min-px and bar-max-px. |
| barMinPx | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| barMaxPx | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| showTotal | booleanDefault: undefined | Set as an HTML attribute or JavaScript property. type: boolean. |
| totalLabel | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
| detectResult | booleanDefault: undefined | Waterfall: recognise a last step given as a plain value equal to the running total as the result bar (default on). |
| lastResult | booleanDefault: undefined | Waterfall: true makes the last merged step a result using the preceding running total and total-color; false disables auto detection; omitted uses detect-result. Explicit datum kinds remain effective when false. |
| labelMode | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
| labelFormat | (bar: unknown) => stringDefault: undefined | Pass as a JavaScript property. type: (bar: unknown) => string. |
| errorColor | stringDefault: undefined | Error bar: the whisker + cap colour; bar mode (a column from zero); the caps' switch. |
| nodeRadius | numberDefault: undefined | Network Graph: circle marker radius and connection width in CSS px. |
GeoMapProjectionDefault: undefined | Geo Map: identity keeps the coordinate frame; mercator selects spherical Mercator. | |
GeoMapFeatureCollectionDefault: undefined | Geo Map: polygon FeatureCollection below the point layer. | |
| polygonColor | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
| polygonOpacity | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| mapColorAxis | GeoMapColorAxisInputDefault: undefined | Geo Map choropleth domain, feature property and palette. |
| mapBubble | GeoMapBubbleInputDefault: undefined | Value-scaled geographic point bubbles. |
| mapHeat | GeoMapHeatInputDefault: undefined | Pass as a JavaScript property. type: GeoMapHeatInput. |
| mapLayers | GeoMapLayersInputDefault: undefined | Geo Map presentation masks; omitted layers remain visible. |
| mapLegend | booleanDefault: false | Set as an HTML attribute or JavaScript property. type: boolean. |
| featureLabels | GeoMapLabelModeDefault: undefined | Geo Map: region/connection name visibility and optional numeric values. |
| featureLabelValue | booleanDefault: undefined | Set as an HTML attribute or JavaScript property. type: boolean. |
| featureTooltipFormat | (detail:GeoMapFeatureHitDetail)=>stringDefault: undefined | Geo Map: custom region/connection tooltip text from owned feature metadata. |
| connectionWidth | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| connectionColor | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
| connectionOpacity | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| connectionPath | GeoMapConnectionPathDefault: 'great-circle' | Geo Map: great-circle arcs or flat-map straight routes; on globes, straight lifts the equirectangular route onto the surface. |
| crosshairSnapDistance | numberDefault: 12 | Geo Map: point-center capture distance in CSS pixels when crosshair.snap is enabled. |
| mapRegion | GeoMapRegionDefault: undefined | Geo Map: fit a continent in 2D, or face it on an orthographic globe. |
| mapBackground | GeoMapBackgroundDefault: undefined | Geo Map: bundled Natural Earth land/coastlines, or no background. |
| mapFixed | booleanDefault: undefined | Geo Map: lock geographic dragging inside the fixed map frame. Flat maps wrap longitude; Albers/Orthographic rotate. Zoom is separate. Default false. |
| linkWidth | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| linkDistance | numberDefault: undefined | Network Graph force layout: spring rest distance in CSS px (default 80). |
numberDefault: undefined | Network Graph force layout: non-negative node repulsion strength (default 2400). | |
| padAngle | numberDefault: undefined | Chord: the gap between neighbouring node arcs in degrees (default 2). |
| nodeWidth | numberDefault: undefined | The nodes' width and the gap between stacked nodes (CSS px). |
| nodePadding | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| nodeAlign | SankeyAlignDefault: undefined | Where a node without a forward path stands: justify / left / right / center. |
| linkColor | stringDefault: undefined | The ribbons' colour (source / target / a CSS colour) and opacity. |
| linkOpacity | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| layoutIterations | numberDefault: undefined | Sankey relaxation passes (default 6) or Network Graph force steps (default 200). Zero keeps the initial placement. |
| linkCurvature | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| nodeLabels | SankeyLabelModeDefault: undefined | Allowed values: auto, show, hide. Default: undefined. |
| nodeLabelValue | booleanDefault: undefined | Set as an HTML attribute or JavaScript property. type: boolean. |
| neighbourDim | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| showBars | booleanDefault: undefined | Set as an HTML attribute or JavaScript property. type: boolean. |
| showCaps | booleanDefault: undefined | Set as an HTML attribute or JavaScript property. type: boolean. |
ArrayLike<number>Default: undefined | Pass as a JavaScript property. type: ArrayLike<number>. | |
| fftSize | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| fftHop | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| fftWindow | SpectrogramWindowKindDefault: undefined | Allowed values: rect, hann, hamming, blackman. Default: undefined. |
| renderPath | HeatmapRenderPathDefault: undefined | Allowed values: auto, plane, cells. Default: undefined. |
HeatmapLodModeDefault: undefined | Allowed values: auto, point, area, smooth. Default: undefined. | |
| areaReduce | 'mean' | 'max'Default: undefined | Allowed values: max, mean. Default: undefined. |
| stemUnit | numberDefault: undefined | Stem-leaf: stem unit — one stem spans this much (default 10). |
| stemSplit | 1 | 2Default: undefined | Stem-leaf: 1 (default) or 2 — each stem splits into 0–4 / 5–9 half-rows. |
| activeColor | stringDefault: undefined | Stem-leaf: accent for the hovered/focused leaf. |
| showKey | booleanDefault: undefined | Stem-leaf: show the reading key (`2 | 3 = 23`) under the plot. |
HistogramBinsRuleDefault: undefined | Histogram: bin rule — `square-root` (default) / `sturges` / `rice` / literal count. | |
'count' | 'percent' | 'density'Default: undefined | Allowed values: percent, count, density. Default: undefined. | |
booleanDefault: undefined | Set as an HTML attribute or JavaScript property. type: boolean. | |
| barGap | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| binWidth | numberDefault: undefined | Histogram: explicit bin width — wins over `bins`. |
| domainMin | numberDefault: undefined | Histogram: domain overrides (outside observations clamp into the edge bins). |
| domainMax | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| edgeColor | stringDefault: undefined | Histogram: 1px separator between gapless bars. |
numberDefault: undefined | Wafer map: wafer diameter in mm. | |
| edgeExclusion | numberDefault: undefined | Wafer map: unusable edge band in mm. |
WaferIndicatorDefault: undefined | Wafer map: orientation-mark kind (`notch` / `flat` / `none`). | |
| waferOrientation | WaferOrientationDefault: undefined | Wafer map: where the orientation mark points. |
| dieWidth | numberDefault: undefined | Wafer map: die size in mm. |
| dieHeight | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| scribeX | numberDefault: undefined | Wafer map: scribe-street widths in mm. |
| scribeY | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| showPartial | booleanDefault: undefined | Wafer map: draw edge (partial) dies. |
| dieIndexOrigin | DieIndexOriginDefault: undefined | Wafer map: die-index convention (`top-left` bounding-box corner / `center` signed). |
| dieIndexBase | numberDefault: undefined | Wafer map: first index value (0 or 1). |
| showDieIndex | booleanDefault: undefined | Wafer map: print `ix,iy` inside each die (auto-hides on small dies). |
WaferMapModeDefault: undefined | Wafer map: colouring mode (`grid` accent / `bin` categorical bin map). | |
| binColors | Readonly<Record<string, string>>Default: undefined | Wafer map: explicit per-bin colours (`{ [bin]: colour }`, property). |
| passBin | number | stringDefault: undefined | Wafer map: the pass bin code (default 1). |
| passColor | stringDefault: undefined | Wafer map: pass-bin fill. |
| failColor | stringDefault: undefined | Wafer map: fail fill for `mode="binary"`. |
| showStats | booleanDefault: undefined | Wafer map: show the statistics line under the value legend. |
'none' | 'defect'Default: undefined | Wafer map: overlay layer (`none` / `defect`). | |
ReadonlyArray<{ x: number; y: number; class?: number | string; size?: number }>Default: undefined | Wafer map: inspection defects (`{x, y, class?, size?}`, wafer mm, property). | |
| defectColor | stringDefault: undefined | Wafer map: dot colour for unclassified defects. |
'die' | 'shot'Default: undefined | Wafer map: grid chrome — `die` (scribe only) or `shot` (+ reticle boundaries). | |
| shotCols | numberDefault: undefined | Wafer map: dies per exposure shot. |
| shotRows | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| shotOffsetX | numberDefault: undefined | Wafer map: shot-grid alignment shift in whole dies. |
| shotOffsetY | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| shotColor | stringDefault: undefined | Wafer map: shot boundary stroke. |
| binLegend | booleanDefault: undefined | Wafer map: show the bin legend under the wafer. |
| sectorPadding | numberDefault: undefined | Polar rose: fraction of each angular slot kept as whitespace, 0..0.8. |
| variableRadius | booleanDefault: undefined | Pie variable-radius mode — each datum's `z` drives the slice's outer radius (Highcharts variablepie). |
| sizeBy | PieChartSizeByDefault: undefined | Variable-radius z→radius mapping: `'area'` (default, radius ∝ √z̄) or `'radius'` (linear). |
| zMin | numberDefault: undefined | Variable-radius z-domain lower bound (defaults to the data minimum). |
| zMax | numberDefault: undefined | Variable-radius z-domain upper bound (defaults to the data maximum). |
| minPointSize | number | stringDefault: undefined | Smallest slice outer DIAMETER — px number or '%' of the full outer diameter (Highcharts minPointSize). |
| maxPointSize | number | stringDefault: undefined | Largest slice outer DIAMETER — px number or '%' of the full outer diameter (Highcharts maxPointSize). |
RadarChartData | FunnelChartData | ReadonlyArray<DumbbellDatum> | ReadonlyArray<DotPlotDatum> | ReadonlyArray<TornadoDatum> | ReadonlyArray<VariwideDatum> | ChordData | NetworkGraphData | TreemapData | SankeyData | ErrorBarData | WaterfallData | BubbleData | BoxPlotData | CandlestickData | CalendarHeatmapData | SpectrogramInput | DensityMapInput | HeatmapData | SunburstData | IcicleData | GanttData | ParallelCoordinatesData | DendrogramData | GeoMapData | Surface3DData | Scatter3DData | FlowLinesData | ThemeRiverData | Bar3DDataDefault: undefined | Radar series array, or variant row data such as dumbbell/dot-plot/tornado. | |
string[]Default: undefined | Radar category spoke labels (property). | |
| gridShape | RadarGridShapeDefault: undefined | Radar grid web shape — `polygon` (spider) or `circle`. |
| gridColor | stringDefault: undefined | Radar grid ring/spoke stroke colour. |
| lineWidth | numberDefault: undefined | Radar polygon outline width in px. |
| showMarkers | booleanDefault: undefined | Shows radar vertex markers. |
| markerRadius | numberDefault: undefined | Radar vertex marker radius in px. |
| showRingLabels | booleanDefault: undefined | Shows labels beside radar rings. |
| ringLabelColor | stringDefault: undefined | Radar ring label colour. |
| ringLabelFontSize | numberDefault: undefined | Radar ring label font size in px. |
| ringLabelFormat | stringDefault: undefined | Radar ring label format string. |
| categoryLabelColor | stringDefault: undefined | Radar category spoke label colour. |
| categoryLabelFontSize | numberDefault: undefined | Radar category spoke label font size in px. |
booleanDefault: undefined | Enables drag-to-edit radar points. | |
| neckWidth | numberDefault: undefined | Funnel neck width as a fraction of the full width (funnel only). |
| neckHeight | numberDefault: undefined | Funnel neck height as a fraction of the total height (the straight bottom band). |
numberDefault: undefined | Vertical gap between funnel/pyramid sections (px). | |
| labelPlacement | FunnelLabelPlacementDefault: undefined | Funnel/pyramid data-label placement. |
| showPercent | booleanDefault: undefined | Show the percentage in funnel/pyramid labels. |
| inactiveOtherSections | booleanDefault: undefined | Dim non-active funnel/pyramid sections when a section is active. |
| inactiveSectionOpacity | numberDefault: undefined | Opacity applied to non-active funnel/pyramid sections. |
| activeSectionIndex | numberDefault: undefined | Controlled active funnel/pyramid section index. Negative/undefined falls back to hover/focus. |
| lineColor | stringDefault: undefined | Cumulative-line colour (pareto only). |
| referenceValue | numberDefault: undefined | 80/20 reference percentage on the cumulative axis (pareto only). |
| showReference | booleanDefault: undefined | Show the pareto reference line. |
| referenceColor | stringDefault: undefined | Pareto reference-line colour. |
| sortDescending | booleanDefault: undefined | Sort pareto categories by value, largest first. Default true. |
| valueAxisLabel | stringDefault: undefined | Left value-axis label (pareto). |
| cumulativeAxisLabel | stringDefault: undefined | Right cumulative-axis label (pareto). |
| markerColor | stringDefault: undefined | Lollipop marker fill override (defaults to `color`). |
'vertical' | 'horizontal'Default: undefined | Lollipop layout direction: `horizontal` (Cleveland, default) or `vertical`. | |
| lowName | stringDefault: undefined | Dumbbell legend label for the low-end markers. |
| highName | stringDefault: undefined | Dumbbell legend label for the high-end markers. |
| lowColor | stringDefault: undefined | Dumbbell low-end marker colour. |
| highColor | stringDefault: undefined | Dumbbell high-end marker colour. |
Float32Array | Array<number | null | undefined>Default: undefined | Variwide column width metric (the 2nd dimension), one per category. | |
booleanDefault: undefined | Variwide: colour each column from the categorical palette. | |
| columnGap | numberDefault: undefined | Variwide gap between columns as a fraction of each slot (0..0.45). |
| leftValues | Float32Array | Array<number | null | undefined>Default: undefined | Deprecated fallback: prefer `data` rows with `values[0]` and `values[1]`. |
| rightValues | Float32Array | Array<number | null | undefined>Default: undefined | Deprecated fallback: prefer `data` rows with `values[0]` and `values[1]`. |
| leftColor | stringDefault: undefined | Tornado left-series bar colour. |
| rightColor | stringDefault: undefined | Tornado right-series bar colour. |
| leftLabel | stringDefault: undefined | Tornado left-series label. |
| rightLabel | stringDefault: undefined | Tornado right-series label. |
| showColumnShare | booleanDefault: undefined | Marimekko: show the per-column total percentage under each column. |
ReadonlyArray<string>Default: undefined | Comparison series = legend labels + colour order (one per value index). | |
| showRowLines | booleanDefault: undefined | Dot-plot: draw a faint guide line across each row between its min and max dot. |
numberDefault: undefined | Gauge primary scalar value. | |
numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. | |
numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. | |
GaugeNeedleSpec[]Default: undefined | Multi-needle override (dial variant). Property-only. | |
GaugeActivityRingSpec[]Default: undefined | Gauge activity-variant rings — each with its own value/max (property-only). | |
stringDefault: undefined | Gauge clock-variant time — 'now' (live) or 'HH:MM(:SS)'. | |
| showSeconds | booleanDefault: undefined | Gauge clock-variant second hand. |
GaugeChartVariantDefault: undefined | Allowed values: solid, dial, activity, vuMeter, speedometer, clock. Default: undefined. | |
| innerRadius | number | stringDefault: undefined | Solid-variant inner radius. Number = px; `'%'` = fraction of outerRadius. |
GaugeColorStop[]Default: undefined | Solid-variant colour stops. Property-only. | |
| needleShape | GaugeNeedleShapeDefault: undefined | Allowed values: needle, arrow, line, wedge. Default: undefined. |
| needleLength | number | stringDefault: undefined | Pass as a JavaScript property. type: number | string. |
| needleRearLength | number | stringDefault: undefined | Pass as a JavaScript property. type: number | string. |
| needleWidth | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| pivotRadius | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| pivotColor | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
| plotBands | GaugePlotBand[] | 'auto'Default: undefined | Gauge plot bands — an array (property), or `'auto'` for %-of-max zones. |
| bandThickness | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| bandTrackColor | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
| valueDisplay | GaugeValueDisplayDefault: undefined | Allowed values: percent, value. Default: undefined. |
booleanDefault: undefined | Set as an HTML attribute or JavaScript property. type: boolean. | |
| trackColor | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
| showTicks | booleanDefault: undefined | Set as an HTML attribute or JavaScript property. type: boolean. |
| tickInterval | number | 'auto'Default: undefined | Allowed values: auto. Default: undefined. |
| minorTicks | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| tickLength | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| minorTickLength | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| tickWidth | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| minorTickWidth | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| tickColor | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
| showTickLabels | booleanDefault: undefined | Set as an HTML attribute or JavaScript property. type: boolean. |
| tickLabelDistance | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| tickLabelColor | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
| tickLabelFontSize | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| tickLabelFormat | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
| showValue | booleanDefault: undefined | Set as an HTML attribute or JavaScript property. type: boolean. |
| valueFormat | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
| valueColor | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
| valueFontSize | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. | |
| analogDamping | numberDefault: undefined | Gauge `analog` needle settle shaping (forwarded to <sy-gauge-chart>). |
| analogFrequency | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| analogOvershootAngle | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
booleanDefault: false | Set as an HTML attribute or JavaScript property. type: boolean. | |
| loadingText | stringDefault: undefined | Loading overlay text override; falls back to the locale string. |
| emptyText | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
| showEmpty | booleanDefault: true | Auto empty state when no finite data point exists. Default `true`. |
boolean | stringDefault: undefined | Pass as a JavaScript property. type: boolean | string. | |
| errorText | stringDefault: undefined | Error body text override (used when `error` is boolean `true`). |
booleanDefault: false | Enables the shared right-click context menu on empty chart area. Default `false`. | |
| contextMenuItems | ChartMenuItem[]Default: undefined | Custom one-level context-menu items (property). Omit for the default export menu. |
| exportFilename | stringDefault: undefined | Base filename (no extension) for exports; falls back to the title or type. |
| exportScale | numberDefault: 2 | Output pixel scale for PNG export (1–8). Default 2 (retina). |
| exportBackground | stringDefault: undefined | Backdrop painted behind PNG/SVG exports; falls back to the theme background. |
ChartThemeName | ChartThemeDefault: undefined | Allowed values: light, dark, high-contrast. Default: undefined. | |
ChartLocaleName | Partial<ChartLocale>Default: undefined | Allowed values: en, ko, ja, zh. Default: undefined. |
Events 67
| Events | Detail type | Description |
|---|---|---|
ChartTypeLoadDetail | Every change of the chart type's load state: loading, ready, or why the type cannot be drawn (ROADMAP-loading §7.2). | |
ChartRenderResult & { type: ChartType; tier: ChartEngineTier } | Emits rendering results in detail when chart drawing completes. | |
ChartAppendedEventDetail | CustomEvent.detail type: ChartAppendedEventDetail. Event names are case-sensitive. | |
{ dropped: number } | CustomEvent.detail type: { dropped: number }. Event names are case-sensitive. | |
void | CustomEvent.detail type: void. Event names are case-sensitive. | |
void | CustomEvent.detail type: void. Event names are case-sensitive. | |
void | CustomEvent.detail type: void. Event names are case-sensitive. | |
ChartPointEventDetail | null | CustomEvent.detail type: ChartPointEventDetail | null. Event names are case-sensitive. | |
GanttDependencyHitDetail | CustomEvent.detail type: GanttDependencyHitDetail. Event names are case-sensitive. | |
GanttTaskEditEventDetail | CustomEvent.detail type: GanttTaskEditEventDetail. Event names are case-sensitive. | |
GanttTaskEditEventDetail | CustomEvent.detail type: GanttTaskEditEventDetail. Event names are case-sensitive. | |
GanttTaskEditEventDetail | CustomEvent.detail type: GanttTaskEditEventDetail. Event names are case-sensitive. | |
GanttTaskEditEventDetail | CustomEvent.detail type: GanttTaskEditEventDetail. Event names are case-sensitive. | |
GanttDependencyHitDetail|null | CustomEvent.detail type: GanttDependencyHitDetail|null. Event names are case-sensitive. | |
GanttDependencySelectionChange | CustomEvent.detail type: GanttDependencySelectionChange. Event names are case-sensitive. | |
ChartPointEventDetail | A point selection event. Read the selected data and index from CustomEvent.detail. | |
ChartPointContextMenuEventDetail | CustomEvent.detail type: ChartPointContextMenuEventDetail. Event names are case-sensitive. | |
RadarChartPointerEventDetail | CustomEvent.detail type: RadarChartPointerEventDetail. Event names are case-sensitive. | |
NetworkGraphNodeDragEventDetail | Network Graph — a node drag begins (after the 3 px threshold), moves and ends; `by` tells a pointer drag from a keyboard nudge. | |
NetworkGraphNodeDragEventDetail | CustomEvent.detail type: NetworkGraphNodeDragEventDetail. Event names are case-sensitive. | |
NetworkGraphNodeDragEventDetail | CustomEvent.detail type: NetworkGraphNodeDragEventDetail. Event names are case-sensitive. | |
{ cssX: number; cssY: number } | CustomEvent.detail type: { cssX: number; cssY: number }. Event names are case-sensitive. | |
CartesianSeriesOutsideClickEventDetail | CustomEvent.detail type: CartesianSeriesOutsideClickEventDetail. Event names are case-sensitive. | |
ChartLegendItemEventDetail | CustomEvent.detail type: ChartLegendItemEventDetail. Event names are case-sensitive. | |
ChartSeriesToggledEventDetail | CustomEvent.detail type: ChartSeriesToggledEventDetail. Event names are case-sensitive. | |
CartesianCrosshairEventDetail | ParallelCoordinatesCrosshairDetail | null | Surface3DCrosshairDetail | Scatter3DCrosshairDetail | ThemeRiverCrosshairDetail | Bar3DCrosshairDetail | CustomEvent.detail type: CartesianCrosshairEventDetail | ParallelCoordinatesCrosshairDetail | null | Surface3DCrosshairDetail | Scatter3DCrosshairDetail | ThemeRiverCrosshairDetail | Bar3DCrosshairDetail. Event names are case-sensitive. | |
CartesianTooltipEventDetail |
PieChartTooltipShowEventDetail |
GaugeChartTooltipShowEventDetail |
RadarChartTooltipShowEventDetail |
FunnelChartTooltipShowEventDetail | Whether to display the built-in tooltip. | |
void | CustomEvent.detail type: void. Event names are case-sensitive. | |
CartesianZoomChangeEventDetail | CustomEvent.detail type: CartesianZoomChangeEventDetail. Event names are case-sensitive. | |
GeoMapViewChangeEventDetail | Geographic camera after a completed globe drag or map-view reset. | |
GeoMapLayerChangeEventDetail | CustomEvent.detail type: GeoMapLayerChangeEventDetail. Event names are case-sensitive. | |
GeoMapFeatureHitDetail | CustomEvent.detail type: GeoMapFeatureHitDetail. Event names are case-sensitive. | |
GeoMapFeatureHitDetail | null | CustomEvent.detail type: GeoMapFeatureHitDetail | null. Event names are case-sensitive. | |
GeoMapFeatureSelectionChangeEventDetail | CustomEvent.detail type: GeoMapFeatureSelectionChangeEventDetail. Event names are case-sensitive. | |
ParallelCoordinatesBrushChangeEventDetail | CustomEvent.detail type: ParallelCoordinatesBrushChangeEventDetail. Event names are case-sensitive. | |
ParallelCoordinatesBrushGestureEventDetail | CustomEvent.detail type: ParallelCoordinatesBrushGestureEventDetail. Event names are case-sensitive. | |
ParallelCoordinatesBrushGestureEventDetail | CustomEvent.detail type: ParallelCoordinatesBrushGestureEventDetail. Event names are case-sensitive. | |
ParallelCoordinatesBrushGestureEventDetail | CustomEvent.detail type: ParallelCoordinatesBrushGestureEventDetail. Event names are case-sensitive. | |
CartesianBrushChangeEventDetail | CustomEvent.detail type: CartesianBrushChangeEventDetail. Event names are case-sensitive. | |
ChartActionEventDetail | CustomEvent.detail type: ChartActionEventDetail. Event names are case-sensitive. | |
{ drawn: number; total: number; done: boolean } | CustomEvent.detail type: { drawn: number; total: number; done: boolean }. Event names are case-sensitive. | |
CartesianBrushStartEventDetail | CustomEvent.detail type: CartesianBrushStartEventDetail. Event names are case-sensitive. | |
CartesianBrushMoveEventDetail | CustomEvent.detail type: CartesianBrushMoveEventDetail. Event names are case-sensitive. | |
CartesianBrushEndEventDetail | CustomEvent.detail type: CartesianBrushEndEventDetail. Event names are case-sensitive. | |
DrawingsChangeEventDetail | CustomEvent.detail type: DrawingsChangeEventDetail. Event names are case-sensitive. | |
DrawingSelectionChangeEventDetail | CustomEvent.detail type: DrawingSelectionChangeEventDetail. Event names are case-sensitive. | |
ChartTooltipActionEventDetail | CustomEvent.detail type: ChartTooltipActionEventDetail. Event names are case-sensitive. | |
PieChartSliceEventDetail | CustomEvent.detail type: PieChartSliceEventDetail. Event names are case-sensitive. | |
PieChartSliceEventDetail | null | CustomEvent.detail type: PieChartSliceEventDetail | null. Event names are case-sensitive. | |
PieChartSelectedEventDetail | CustomEvent.detail type: PieChartSelectedEventDetail. Event names are case-sensitive. | |
{ index: number; sliceId: string; disabled: boolean } | CustomEvent.detail type: { index: number; sliceId: string; disabled: boolean }. Event names are case-sensitive. | |
SankeySelectionChangeEventDetail | ChordSelectionChangeEventDetail | NetworkGraphSelectionChangeEventDetail | TreemapSelectionChangeEventDetail | SunburstSelectionChangeEventDetail | IcicleSelectionChangeEventDetail | GanttSelectionChangeEventDetail | ParallelCoordinatesSelectionChangeEventDetail | DendrogramSelectionChangeEventDetail | GeoMapSelectionChangeEventDetail | Surface3DSelectionChangeEventDetail | Scatter3DSelectionChangeEventDetail | FlowLinesSelectionChangeEventDetail | ThemeRiverSelectionChangeEventDetail | Bar3DSelectionChangeEventDetail | CustomEvent.detail type: SankeySelectionChangeEventDetail | ChordSelectionChangeEventDetail | NetworkGraphSelectionChangeEventDetail | TreemapSelectionChangeEventDetail | SunburstSelectionChangeEventDetail | IcicleSelectionChangeEventDetail | GanttSelectionChangeEventDetail | ParallelCoordinatesSelectionChangeEventDetail | DendrogramSelectionChangeEventDetail | GeoMapSelectionChangeEventDetail | Surface3DSelectionChangeEventDetail | Scatter3DSelectionChangeEventDetail | FlowLinesSelectionChangeEventDetail | ThemeRiverSelectionChangeEventDetail | Bar3DSelectionChangeEventDetail. Event names are case-sensitive. | |
TreemapDrillChangeEventDetail | SunburstDrillChangeEventDetail | IcicleDrillChangeEventDetail | DendrogramDrillChangeEventDetail | Treemap branch navigation through pointer, keyboard, methods or data reconciliation. | |
GaugeChartPointerEventDetail | CustomEvent.detail type: GaugeChartPointerEventDetail. Event names are case-sensitive. | |
GaugeChartPointerEventDetail | null | CustomEvent.detail type: GaugeChartPointerEventDetail | null. Event names are case-sensitive. | |
{ value: number; fraction: number } | CustomEvent.detail type: { value: number; fraction: number }. Event names are case-sensitive. | |
{ index: number; needleId: string; disabled: boolean } | CustomEvent.detail type: { index: number; needleId: string; disabled: boolean }. Event names are case-sensitive. | |
FunnelChartPointerEventDetail | CustomEvent.detail type: FunnelChartPointerEventDetail. Event names are case-sensitive. | |
FunnelChartPointerEventDetail | null | CustomEvent.detail type: FunnelChartPointerEventDetail | null. Event names are case-sensitive. | |
{ index: number; sectionId: string; disabled: boolean } | CustomEvent.detail type: { index: number; sectionId: string; disabled: boolean }. Event names are case-sensitive. | |
Surface3DCameraChangeEventDetail | CustomEvent.detail type: Surface3DCameraChangeEventDetail. Event names are case-sensitive. | |
ChartDataValidationErrorDetail | CustomEvent.detail type: ChartDataValidationErrorDetail. Event names are case-sensitive. | |
ChartContextMenuEventDetail | CustomEvent.detail type: ChartContextMenuEventDetail. Event names are case-sensitive. | |
void | CustomEvent.detail type: void. Event names are case-sensitive. | |
ChartContextMenuItemEventDetail | CustomEvent.detail type: ChartContextMenuItemEventDetail. Event names are case-sensitive. | |
{ format: 'png' | 'svg' | 'csv' | 'json'; filename: string } | CustomEvent.detail type: { format: 'png' | 'svg' | 'csv' | 'json'; filename: string }. Event names are case-sensitive. | |
{ open: boolean } | CustomEvent.detail type: { open: boolean }. Event names are case-sensitive. |
Methods 250
Stencil methods return Promises. Use await within an async function to read the result.
| Method / Arguments | Return type | Description |
|---|---|---|
Promise<FlowLinesData|null> | An asynchronous method. Check the argument and return types below. | |
Promise<FlowLinesLayout|null> | An asynchronous method. Check the argument and return types below. | |
Promise<FlowLinesDiagnostics|null> | An asynchronous method. Check the argument and return types below. | |
| id: FlowLinesId, kind?: 'flow'|'location' | Promise<FlowLinesHitDetail|null> | An asynchronous method. Check the argument and return types below. |
| index: number, kind?: 'flow'|'location' | Promise<CartesianTooltipEventDetail|null> | An asynchronous method. Check the argument and return types below. |
Promise<void> | An asynchronous method. Check the argument and return types below. | |
Promise<void> | An asynchronous method. Check the argument and return types below. | |
Promise<ThemeRiverData|null> | An asynchronous method. Check the argument and return types below. | |
Promise<ThemeRiverLayout|null> | An asynchronous method. Check the argument and return types below. | |
Promise<ThemeRiverDiagnostics|null> | An asynchronous method. Check the argument and return types below. | |
| series: number, column: number | Promise<ThemeRiverHitDetail|null> | An asynchronous method. Check the argument and return types below. |
| series: number, column: number | Promise<CartesianTooltipEventDetail|null> | An asynchronous method. Check the argument and return types below. |
| series: number, column: number | Promise<boolean> | An asynchronous method. Check the argument and return types below. |
Promise<void> | An asynchronous method. Check the argument and return types below. | |
Promise<void> | An asynchronous method. Check the argument and return types below. | |
Promise<Bar3DDatum[]|null> | Surface grid coordinates are row/column; generic tooltip methods use a row-major sample index. | |
Promise<Scatter3DDatum[]|null> | An asynchronous method. Check the argument and return types below. | |
Promise<Bar3DGeometry|null> | An asynchronous method. Check the argument and return types below. | |
Promise<Scatter3DGeometry|null> | An asynchronous method. Check the argument and return types below. | |
Promise<Bar3DDiagnostics|null> | An asynchronous method. Check the argument and return types below. | |
Promise<Scatter3DDiagnostics|null> | An asynchronous method. Check the argument and return types below. | |
| index: number | Promise<Bar3DHitDetail|null> | An asynchronous method. Check the argument and return types below. |
| index: number | Promise<Scatter3DHitDetail|null> | An asynchronous method. Check the argument and return types below. |
| index: number | Promise<CartesianTooltipEventDetail|null> | An asynchronous method. Check the argument and return types below. |
| index: number | Promise<CartesianTooltipEventDetail|null> | An asynchronous method. Check the argument and return types below. |
| index: number | Promise<boolean> | An asynchronous method. Check the argument and return types below. |
| index: number | Promise<boolean> | An asynchronous method. Check the argument and return types below. |
Promise<Surface3DGrid|null> | An asynchronous method. Check the argument and return types below. | |
Promise<Surface3DGeometry|null> | An asynchronous method. Check the argument and return types below. | |
Promise<Surface3DDiagnostics|null> | An asynchronous method. Check the argument and return types below. | |
| row: number, column: number | Promise<Surface3DHitDetail|null> | An asynchronous method. Check the argument and return types below. |
| row: number, column: number | Promise<CartesianTooltipEventDetail|null> | An asynchronous method. Check the argument and return types below. |
| row: number, column: number | Promise<boolean> | An asynchronous method. Check the argument and return types below. |
Promise<Scene3DCameraOptions|null> | An asynchronous method. Check the argument and return types below. | |
| options: Scene3DCameraOptions | Promise<void> | An asynchronous method. Check the argument and return types below. |
| projection: Scene3DProjection | Promise<void> | An asynchronous method. Check the argument and return types below. |
| padding?: number | Promise<void> | An asynchronous method. Check the argument and return types below. |
Promise<void> | An asynchronous method. Check the argument and return types below. | |
Promise<void> | An asynchronous method. Check the argument and return types below. | |
| azimuth: number, polar?: number | Promise<void> | An asynchronous method. Check the argument and return types below. |
| x: number, y: number | Promise<void> | Pan the 3D camera in CSS pixels; use zoomBy for camera distance/orthographic zoom. |
Promise<void> | An asynchronous method. Check the argument and return types below. | |
Promise<void> | An asynchronous method. Check the argument and return types below. | |
Promise<void> | An asynchronous method. Check the argument and return types below. | |
Promise<void> | An asynchronous method. Check the argument and return types below. | |
Promise<ChartDataTable> | An asynchronous method. Check the argument and return types below. | |
Promise<string> | Returns the chart data as a CSV string (UTF-8 BOM, RFC 4180). | |
Promise<string | null> | An asynchronous method. Check the argument and return types below. | |
Promise<void> | An asynchronous method. Check the argument and return types below. | |
Promise<void> | An asynchronous method. Check the argument and return types below. | |
Promise<void> | An asynchronous method. Check the argument and return types below. | |
Promise<void> | Prints an inlined snapshot of the chart (Highcharts `printChart`), brand included. The snapshot goes into a hidden frame of this document that prints itself: the former popup (`window.open(…, 'noopener,noreferrer')`) always got `null` back — `noopener` hides the new window from its opener — so nothing was ever printed, and a popup opened after the awaited export would also meet popup blockers. The frame is built with DOM calls only: the chart title becomes the document title and the image's alt text as plain text (never HTML), and no inline script or handler is needed. Rejects with a ChartLoadError when the type cannot be drawn here. | |
| enabled: boolean | Promise<void> | Enables or disables the shared right-click context menu at runtime. |
| options?: ChartContextMenuOpenOptions | Promise<void> | Opens the shared context menu at chart-local coordinates, or the chart centre when omitted. |
Promise<void> | Closes the shared context menu. | |
Promise<void> | An asynchronous method. Check the argument and return types below. | |
Promise<void> | Closes the accessible data table dialog. | |
Promise<ChartRenderResult> | An asynchronous method. Check the argument and return types below. | |
Promise<{ pass: number; fail: number; probed: number; yield: number } | null> | Wafer map: pass/fail/yield summary over the probed dies (`null` on other types). | |
Promise<{ count: number; min: number; max: number; mean: number; stdDev: number; median: number } | null> | Wafer map: statistics over the measured die values (`null` on other types). | |
Promise<{ total: number; offWafer: number; byClass: Array<{ key: string; count: number }> } | null> | Wafer map: per-class defect summary (`null` on other types). | |
| col: number, row: number | Promise<{ shotCol: number; shotRow: number } | null> | Wafer map: shot (reticle) coordinate of a lattice cell (`null` on other types). |
| cssX: number, cssY: number | Promise<unknown | null> | Wafer map: die under a component-local CSS point (`null` off-die or on other types). |
| col: number, row: number | Promise<unknown | null> | Wafer map: select a die programmatically (`null` off-lattice or on other types). |
Promise<void> | Wafer map: clear the die selection. | |
Promise<unknown | null> | Wafer map: the current die selection (`null` when none or on other types). | |
| datum: { col: number; row: number; bin?: number | string; value?: number } | Promise<void> | Wafer map: stream one probe result in (cell upsert; re-tests emit `binChanged`). |
| col: number, row: number, patch: { bin?: number | string; value?: number } | Promise<unknown | null> | Wafer map: patch one die's data (creates the cell when absent). |
| col: number, row: number | Promise<DieIndexEntry | null> | Wafer map: map index of a notch-frame lattice cell (`null` off-wafer or on other types). |
| ix: number, iy: number | Promise<DieIndexEntry | null> | Wafer map: die entry addressed by its map index (`null` off-wafer or on other types). |
Promise<number | undefined> | The waterfall's running total after its last step (the value a total bar stands to); `undefined` on any other type. | |
Promise<ChartTypeLoadDetail> | The chart type's current load answer (ROADMAP-loading §7.2): status, tag, entitlement state, reason and attempt. | |
Promise<ChartTypeLoadDetail> | Resolves once the chart type's answer is settled — ready, or the reason it cannot be drawn — after a pending license or an import in flight. Never rejects: check `status`. | |
Promise<ChartTypeLoadDetail> | Asks for the chart type again (a new attempt), e.g. after `load-failed`; resolves with the settled answer. | |
Promise<ChartEngineStatus | null> | The engine behind the chart (ROADMAP-loading §5.3): the element's own getEngineStatus() once the type is drawn; while it cannot be, the facade's answer — `unavailable` with the license code, `module-missing` (not installed or not selected) or `load-failed` (the element's chunk). Null while the type is loading, for an unknown type, and before the element answers. | |
Promise<ChartEngineTier> | An asynchronous method. Check the argument and return types below. | |
| data: RadarChartData | FunnelChartData | ReadonlyArray<VariwideDatum> | HeatmapData | DensityMapInput | SpectrogramInput | CalendarHeatmapData | CandlestickData | BoxPlotData | BubbleData | WaterfallData | ErrorBarData | SankeyData | ChordData | NetworkGraphData | TreemapData | SunburstData | IcicleData | GanttData | ParallelCoordinatesData | DendrogramData | GeoMapData | Surface3DData | Scatter3DData | FlowLinesData | ThemeRiverData | Bar3DData | Promise<void> | An asynchronous method. Check the argument and return types below. |
| options: LineChartSeries | ScatterChartSeries, opts?: { redraw?: boolean; insertAt?: number } | Promise<number> | An asynchronous method. Check the argument and return types below. |
| idOrIndex: string | number, opts?: { redraw?: boolean } | Promise<boolean> | An asynchronous method. Check the argument and return types below. |
| idOrIndex: string | number, patch: Partial<LineChartSeries | ScatterChartSeries>, opts?: { redraw?: boolean } | Promise<boolean> | An asynchronous method. Check the argument and return types below. |
| seriesIdOrIndex: string | number, categoryIdOrIndex: string | number, value: number | null | Promise<boolean> | Radar-only — patch one category value in a series. |
| idOrIndex: string | number, data: LineChartValues | ScatterChartValues, opts?: { redraw?: boolean } | Promise<boolean> | An asynchronous method. Check the argument and return types below. |
| idOrIndex: string | number, point: number | ScatterChartDatum, opts?: { shift?: boolean; redraw?: boolean } | Promise<boolean> | An asynchronous method. Check the argument and return types below. |
| idOrIndex: string | number, opts?: { redraw?: boolean } | Promise<boolean> | An asynchronous method. Check the argument and return types below. |
| idOrIndex: string | number, opts?: { redraw?: boolean } | Promise<boolean> | An asynchronous method. Check the argument and return types below. |
| value: number | ScatterChartDatum | PieChartDatum | RadarStreamFrame | FunnelSectionSpec | ChordLinkInput | NetworkGraphLinkInput | TreemapNodeInput | SunburstNodeInput | IcicleNodeInput | GanttTaskInput | ParallelCoordinatesRowInput | DendrogramNodeInput | GeoMapPointInput | Surface3DRowInput | Scatter3DDatum | FlowLinesRouteInput | ThemeRiverRow | Bar3DDatum | Promise<void> | An asynchronous method. Check the argument and return types below. |
| values: ReadonlyArray<number> | Float32Array | ScatterChartValues | ReadonlyArray<PieChartDatum> | ReadonlyArray<RadarStreamFrame> | ReadonlyArray<FunnelSectionSpec | number> | ReadonlyArray<ChordLinkInput> | ReadonlyArray<NetworkGraphLinkInput> | ReadonlyArray<TreemapNodeInput> | ReadonlyArray<SunburstNodeInput> | ReadonlyArray<IcicleNodeInput> | ReadonlyArray<GanttTaskInput> | ReadonlyArray<ParallelCoordinatesRowInput> | ReadonlyArray<DendrogramNodeInput> | ReadonlyArray<GeoMapPointInput> | ReadonlyArray<Surface3DRowInput> | ReadonlyArray<Scatter3DDatum> | ReadonlyArray<FlowLinesRouteInput | ThemeRiverRow> | ReadonlyArray<Bar3DDatum> | Promise<void> | An asynchronous method. Check the argument and return types below. |
| count: number | Promise<void> | An asynchronous method. Check the argument and return types below. |
| values: ReadonlyArray<number> | Float32Array | ScatterChartValues | ReadonlyArray<PieChartDatum> | ReadonlyArray<RadarStreamFrame> | ReadonlyArray<FunnelSectionSpec | number> | ReadonlyArray<ChordLinkInput> | ReadonlyArray<NetworkGraphLinkInput> | ReadonlyArray<TreemapNodeInput> | ReadonlyArray<SunburstNodeInput> | ReadonlyArray<IcicleNodeInput> | ReadonlyArray<GanttTaskInput> | ReadonlyArray<ParallelCoordinatesRowInput> | ReadonlyArray<DendrogramNodeInput> | ReadonlyArray<GeoMapPointInput> | ReadonlyArray<Surface3DRowInput> | ReadonlyArray<Scatter3DDatum> | ReadonlyArray<FlowLinesRouteInput | ThemeRiverRow> | ReadonlyArray<Bar3DDatum> | Promise<void> | An asynchronous method. Check the argument and return types below. |
Promise<ChartStreamSource | undefined> | An asynchronous method. Check the argument and return types below. | |
| options: { duration?: number; easing?: LineChartEasing; enabled?: boolean; type?: ChartAnimationType } | Promise<void> | An asynchronous method. Check the argument and return types below. |
Promise<void> | An asynchronous method. Check the argument and return types below. | |
Promise<void> | An asynchronous method. Check the argument and return types below. | |
Promise<void> | Pie / gauge — replay the initial reveal (pie sweep-from-zero, gauge sweep-from-min). | |
| value: number | Promise<void> | Gauge-only — set the primary value. |
Promise<number> | Gauge-only — read the current primary value. | |
| needle: GaugeNeedleSpec, opts?: { insertAt?: number } | Promise<number> | Gauge-only — add a needle (dial variant). |
| idOrIndex: string | number | Promise<boolean> | Gauge-only — remove a needle by id or index. |
| idOrIndex: string | number, patch: Partial<GaugeNeedleSpec> | Promise<boolean> | Gauge-only — patch a needle. |
| section: FunnelSectionSpec | number, opts?: { insertAt?: number } | Promise<number> | Funnel / pyramid-only — add a section (stage). Returns its index. |
| idOrIndex: string | number | Promise<boolean> | Funnel / pyramid-only — remove a section by id or index. |
| idOrIndex: string | number, patch: Partial<FunnelSectionSpec> | Promise<boolean> | Funnel / pyramid-only — patch a section. |
| cssX: number, cssY: number | Promise<RadarChartPointerEventDetail | FunnelChartPointerEventDetail | ChordHitDetail | NetworkGraphHitDetail | TreemapHitDetail | null | SunburstHitDetail | IcicleHitDetail | GanttHitDetail | ParallelCoordinatesHitDetail | DendrogramHitDetail | GeoMapPickDetail | Surface3DHitDetail | Scatter3DHitDetail | FlowLinesHitDetail | ThemeRiverHitDetail | Bar3DHitDetail> | Radar / funnel / pyramid — hit-test the polar/radial SVG at chart-local coordinates. |
| seriesIndex: number, categoryIndex: number | Promise<RadarChartPointerEventDetail | null> | Radar-only — open a vertex tooltip by series/category index. |
| idOrIndex: string | number | Promise<FunnelChartPointerEventDetail | null> | Funnel / pyramid-only — open a section tooltip by id or index. |
| cssX: number, cssY: number | Promise<GaugeChartPointerEventDetail | null> | Gauge-only — hit-test the dial at canvas coordinates. |
Promise<GaugeChartPointerEventDetail | null> | Gauge-only — open the value tooltip programmatically. | |
| value: number | Promise<GaugeChartPointerEventDetail | null> | Gauge-only — open the value tooltip at a specific value's angle (analogue of showTooltipAtSlice). |
| rings: GaugeActivityRingSpec[] | Promise<void> | Gauge-only (activity) — replace the ring set. |
| idOrIndex: string | number, value: number | Promise<boolean> | Gauge-only (activity) — update one ring's value by id, name, or index. |
| index: number | Promise<SankeyNodeEventDetail | ChordNodeEventDetail | NetworkGraphNodeEventDetail | TreemapHitDetail | null | SunburstHitDetail | IcicleHitDetail | GanttHitDetail | ParallelCoordinatesHitDetail | DendrogramHitDetail | GeoMapHitDetail> | Sankey / Chord / Network Graph — pin a node by index; its neighbourhood stays highlighted after pointer leave. A negative or unknown index releases selection. `null` on other types. |
| index: number | Promise<ParallelCoordinatesHitDetail|null> | Treemap: enter a positive branch by ID, or null for the forest. Requires drilldown. Select a visible Gantt task by its normalized source index. Parallel Coordinates: source rows and independent axis geometry. |
Promise<ParallelCoordinatesRow[]> | An asynchronous method. Check the argument and return types below. | |
| index: number | Promise<ParallelCoordinatesRow|null> | An asynchronous method. Check the argument and return types below. |
| id: string | Promise<ParallelCoordinatesRow|null> | An asynchronous method. Check the argument and return types below. |
Promise<number> | An asynchronous method. Check the argument and return types below. | |
Promise<ParallelCoordinatesLayoutResult|null> | An asynchronous method. Check the argument and return types below. | |
| brushes: ReadonlyArray<ParallelCoordinatesAxisBrush>|null | Promise<ParallelCoordinatesBrushChangeEventDetail|null> | An asynchronous method. Check the argument and return types below. |
| dimensionId: string, range: readonly[number,number]|null | Promise<ParallelCoordinatesBrushChangeEventDetail|null> | An asynchronous method. Check the argument and return types below. |
| dimensionId?: string | Promise<ParallelCoordinatesBrushChangeEventDetail|null> | An asynchronous method. Check the argument and return types below. |
Promise<ParallelCoordinatesAxisBrush[]> | An asynchronous method. Check the argument and return types below. | |
Promise<ParallelCoordinatesRow[]> | An asynchronous method. Check the argument and return types below. | |
Promise<ParallelCoordinatesBrushModel[]> | An asynchronous method. Check the argument and return types below. | |
Promise<ParallelCoordinatesLineModel[]> | An asynchronous method. Check the argument and return types below. | |
Promise<ParallelCoordinatesAxisModel[]> | An asynchronous method. Check the argument and return types below. | |
Promise<ParallelCoordinatesAxis[]> | An asynchronous method. Check the argument and return types below. | |
Promise<ParallelCoordinatesDiagnostics|null> | An asynchronous method. Check the argument and return types below. | |
| index: number | Promise<GanttHitDetail | null> | An asynchronous method. Check the argument and return types below. |
Promise<GanttTask[]> | An asynchronous method. Check the argument and return types below. | |
| index: number | Promise<GanttTask | null> | An asynchronous method. Check the argument and return types below. |
| id: string | Promise<GanttTask | null> | An asynchronous method. Check the argument and return types below. |
Promise<number> | An asynchronous method. Check the argument and return types below. | |
Promise<GanttExtent | null> | An asynchronous method. Check the argument and return types below. | |
Promise<GanttLayoutResult | null> | An asynchronous method. Check the argument and return types below. | |
Promise<GanttDiagnostics|null> | An asynchronous method. Check the argument and return types below. | |
Promise<GanttLabel[]> | An asynchronous method. Check the argument and return types below. | |
Promise<GanttBaselineComparison[]> | An asynchronous method. Check the argument and return types below. | |
Promise<GanttTaskEdit[]> | An asynchronous method. Check the argument and return types below. | |
| id?: string | Promise<void> | An asynchronous method. Check the argument and return types below. |
Promise<boolean> | An asynchronous method. Check the argument and return types below. | |
Promise<GanttCriticalPathResult|null> | An asynchronous method. Check the argument and return types below. | |
Promise<GanttDependencyDataset|null> | An asynchronous method. Check the argument and return types below. | |
Promise<GanttDependencyPath[]> | An asynchronous method. Check the argument and return types below. | |
Promise<GanttDependencySelection|null> | An asynchronous method. Check the argument and return types below. | |
| index: number | Promise<GanttDependencyHitDetail|null> | An asynchronous method. Check the argument and return types below. |
| x: number, y: number | Promise<GanttDependencyHitDetail|null> | An asynchronous method. Check the argument and return types below. |
| index: number | Promise<CartesianTooltipEventDetail|null> | An asynchronous method. Check the argument and return types below. |
Promise<GanttTimeAxisModel | null> | An asynchronous method. Check the argument and return types below. | |
| rootId: string | null | Promise<TreemapDrillChangeEventDetail | null | SunburstDrillChangeEventDetail | IcicleDrillChangeEventDetail | DendrogramDrillChangeEventDetail> | An asynchronous method. Check the argument and return types below. |
| nodeIndex: number | Promise<TreemapDrillChangeEventDetail | null | SunburstDrillChangeEventDetail | IcicleDrillChangeEventDetail | DendrogramDrillChangeEventDetail> | Treemap: enter a branch by its normalized data index. Requires drilldown. |
Promise<TreemapDrillChangeEventDetail | null | SunburstDrillChangeEventDetail | IcicleDrillChangeEventDetail | DendrogramDrillChangeEventDetail> | Treemap: return to the parent branch, then the forest. | |
Promise<TreemapNode | null | SunburstNode | IcicleNode | DendrogramNode> | Treemap: current branch with its original identity and index, or null for the forest. | |
| index: number | Promise<SankeyLinkEventDetail | ChordLinkEventDetail | NetworkGraphLinkEventDetail | DendrogramHitDetail | null> | Sankey / Chord / Network Graph — pin a link by index; it keeps the accent after pointer leave. A negative or unknown index releases selection. `null` on other types. |
Promise<void> | Sankey / Chord / Network Graph — release selection (a no-op on other types). | |
| id: string, x: number, y: number | Promise<NetworkGraphPinnedNode | null> | Sankey / Chord / Network Graph — `{ node, link }` selection details, each nullable; `null` on other types. Network Graph — hold a node at a plot-local position (as a drag does); null on other types or unknown ids. |
| id: string | Promise<boolean> | Network Graph — release a pinned node; false on other types or when it was not pinned. |
Promise<number> | Network Graph — release every pinned node; the count released. | |
Promise<NetworkGraphPinnedNode[]> | Network Graph — the pinned nodes at their applied positions; empty on other types. | |
Promise<SankeySelection | ChordSelection | NetworkGraphSelection | TreemapSelection | null | SunburstSelection | IcicleSelection | GanttSelection | ParallelCoordinatesSelection | DendrogramSelection | GeoMapSelection | Surface3DSelection | Scatter3DSelection | FlowLinesSelection | ThemeRiverSelection | Bar3DSelection> | An asynchronous method. Check the argument and return types below. | |
| idOrIndex: string | number, selected?: boolean | Promise<boolean> | Pie-only — select a slice by id or index. |
| idOrIndex: string | number | Promise<boolean> | Pie-only — clear selection on a slice. |
Promise<string[]> | Pie-only — read the current selection set. | |
| cssX: number, cssY: number | Promise<{ sliceIndex: number; sliceId: string } | null> | Pie-only — hit-test slice at canvas-relative coordinates. |
| idOrIndex: string | number | Promise<PieChartSliceEventDetail | null> | Pie-only — programmatic tooltip open. |
| datum: ItemChartDatum, opts?: { insertAt?: number } | Promise<number> | Item-only — add a party (datum) to the parliament. |
| idOrIndex: string | number | Promise<boolean> | Item-only — remove a party by id, name, or index. |
| idOrIndex: string | number, patch: Partial<Exclude<ItemChartDatum, number>> | Promise<boolean> | Item-only — patch a party's datum fields. |
| idOrIndex: string | number, value: number | Promise<boolean> | Item-only — set a party's seat count. |
| cssX: number, cssY: number | Promise<{ partyIndex: number; partyId: string; seatIndex: number; seatInParty: number } | null> | Item-only — hit-test the seat dot at canvas-relative coordinates. |
| idOrIndex: string | number | Promise<ItemChartPointEventDetail | null> | Item-only — programmatic tooltip open on a party. |
| datum: WordCloudDatum, opts?: { insertAt?: number } | Promise<number> | Word-cloud-only — add a word datum. |
| idOrIndex: string | number | Promise<boolean> | Word-cloud-only — remove a word by id, name, or index. |
| idOrIndex: string | number, patch: Partial<Exclude<WordCloudDatum, readonly [string, number]>> | Promise<boolean> | Word-cloud-only — patch a word's datum fields. |
| idOrIndex: string | number, weight: number | Promise<boolean> | Word-cloud-only — set a word's weight. |
| cssX: number, cssY: number | Promise<{ index: number; id: string; name: string } | null> | Word-cloud-only — hit-test the word at canvas-relative coordinates. |
Promise<Array<{ index: number; id: string; name: string; weight: number }>> | Word-cloud-only — words the spiral could not fit inside the plot. | |
| idOrIndex: string | number | Promise<WordCloudPointEventDetail | null> | Word-cloud-only — programmatic tooltip open on a word. |
| datum: TilemapDatum | Promise<number> | Tilemap-only — append a tile datum (occupied cells update in place). |
| idOrCell: string | number | { x: number; y: number } | Promise<boolean> | Tilemap-only — remove a tile by id, name, index, or `{x, y}` cell. |
| idOrCell: string | number | { x: number; y: number }, patch: Partial<TilemapDatum> | Promise<boolean> | Tilemap-only — patch a tile's datum fields. |
| idOrCell: string | number | { x: number; y: number }, value: number | Promise<boolean> | Tilemap-only — set a tile's metric value. |
| cssX: number, cssY: number | Promise<{ index: number; id: string; col: number; row: number; name: string } | null> | Tilemap-only — hit-test the tile at canvas-relative coordinates. |
| idOrCell: string | number | { x: number; y: number } | Promise<TilemapPointEventDetail | null> | Tilemap-only — programmatic tooltip open on a tile. |
| cssX: number, cssY: number | Promise<{ sourceIndex: number; value: number; stemLabel: string; digit: number } | null> | Stem-leaf-only — hit-test the leaf at canvas-relative coordinates. |
| sourceIndex: number | Promise<StemLeafPointEventDetail | null> | Stem-leaf-only — programmatic tooltip open on a leaf by source index. |
| cssX: number, cssY: number | Promise<PolarChartPointEventDetail | null> | Polar-only — hit-test the rose segment at canvas-relative coordinates. |
| categoryIndex: number, seriesIdOrIndex: string | number | Promise<PolarChartPointEventDetail | null> | Polar-only — programmatic tooltip open on a (direction, series) cell. |
| clientX: number, clientY: number | Promise<LineChartPointEventDetail | null> | An asynchronous method. Check the argument and return types below. |
| clientX: number, clientY: number | Promise<LineChartPointEventDetail[]> | An asynchronous method. Check the argument and return types below. |
| pointIndex: number, seriesIndex?: number | 'left' | 'right' | Promise<CartesianTooltipEventDetail | null> | An asynchronous method. Check the argument and return types below. |
| request: CartesianZoomRequest | Promise<CartesianZoomChangeEventDetail | null> | An asynchronous method. Check the argument and return types below. |
| factor: number, anchorFraction?: number | Promise<CartesianZoomChangeEventDetail | null> | An asynchronous method. Check the argument and return types below. |
| delta: { x?: number; y?: number } | Promise<CartesianZoomChangeEventDetail | null> | An asynchronous method. Check the argument and return types below. |
Promise<CartesianZoomChangeEventDetail | null> | An asynchronous method. Check the argument and return types below. | |
Promise<void> | Geo Map: restore the configured projection/region and clear viewport zoom. | |
| input: unknown, objectName?: string | Promise<GeoMapFeatureCollection | null> | Geo Map: decode TopoJSON without changing data. Returns null for other chart types or an unavailable child. |
| input: unknown | Promise<GeoMapFeatureCollection | null> | Geo Map: decode RFC 7946 GeoJSON without changing data. Returns null for other types or an unavailable child. |
| features?: GeoMapFeatureCollection | Promise<void> | Geo Map: atomically validate and replace the polygon layer. |
Promise<GeoMapFeatureCollection | null> | An asynchronous method. Check the argument and return types below. | |
Promise<GeoMapHeatDetail|null> | An asynchronous method. Check the argument and return types below. | |
Promise<GeoMapLayerDetail[]> | An asynchronous method. Check the argument and return types below. | |
| layer: GeoMapLayer, visible: boolean | Promise<GeoMapLayerDetail|null> | An asynchronous method. Check the argument and return types below. |
| options?: GeoMapFitOptions | Promise<GeoMapFitDetail|null> | An asynchronous method. Check the argument and return types below. |
Promise<GeoMapLabelView|null> | An asynchronous method. Check the argument and return types below. | |
Promise<GeoMapViewDetail|null> | An asynchronous method. Check the argument and return types below. | |
| cssX: number, cssY: number | Promise<GeoMapHeatPointDetail|null> | An asynchronous method. Check the argument and return types below. |
| longitude: number, latitude: number | Promise<GeoMapHeatPointDetail|null> | Current visible density at longitude/latitude; null when hidden, clipped or outside the viewport. |
Promise<GeoMapBubbleScaleDetail|null> | An asynchronous method. Check the argument and return types below. | |
Promise<GeoMapColorAxisDetail|null> | An asynchronous method. Check the argument and return types below. | |
Promise<GeoMapDiagnostics|null> | Current Geo Map normalization counters; null for another type or an absent child. | |
Promise<GeoMapAvailabilityDetail|null> | Geo Map requested/active engine, asynchronous readiness and unavailable reason; null for other families or a missing child. | |
| index: number | Promise<GeoMapFeatureHitDetail | null> | An asynchronous method. Check the argument and return types below. |
Promise<GeoMapFeatureSelection | null> | An asynchronous method. Check the argument and return types below. | |
| index: number | Promise<CartesianTooltipEventDetail | null> | An asynchronous method. Check the argument and return types below. |
Promise<CartesianZoomState | null> | An asynchronous method. Check the argument and return types below. | |
| request?: CartesianZoomExtentRequest | Promise<CartesianZoomExtentDetail | null> | An asynchronous method. Check the argument and return types below. |
| charts: ReadonlyArray<HTMLElement | string>, options?: ZoomConnectOptions | Promise<number> | An asynchronous method. Check the argument and return types below. |
Promise<void> | An asynchronous method. Check the argument and return types below. | |
| request: Bar3DCrosshairShowRequest | Promise<boolean> | An asynchronous method. Check the argument and return types below. |
Promise<void> | An asynchronous method. Check the argument and return types below. | |
| areas: ReadonlyArray<CartesianBrushAreaInput> | null | Promise<CartesianBrushChangeEventDetail | null> | An asynchronous method. Check the argument and return types below. |
Promise<CartesianBrushChangeEventDetail | null> | An asynchronous method. Check the argument and return types below. | |
Promise<CartesianBrushArea[]> | An asynchronous method. Check the argument and return types below. | |
Promise<CartesianBrushSelectedSeries[]> | An asynchronous method. Check the argument and return types below. | |
Promise<ChartDrawing[]> | An asynchronous method. Check the argument and return types below. | |
| drawings: ReadonlyArray<ChartDrawingInput> | null | Promise<DrawingsChangeEventDetail | null> | An asynchronous method. Check the argument and return types below. |
| drawing: ChartDrawingInput | Promise<ChartDrawing | null> | An asynchronous method. Check the argument and return types below. |
| id: string, patch: Partial<Omit<ChartDrawing, 'id'>> | Promise<ChartDrawing | null> | An asynchronous method. Check the argument and return types below. |
| id: string | Promise<boolean> | An asynchronous method. Check the argument and return types below. |
| ids: ReadonlyArray<string> | Promise<DrawingsChangeEventDetail | null> | An asynchronous method. Check the argument and return types below. |
| id: string, space: DrawingSpace | Promise<ChartDrawing | null> | An asynchronous method. Check the argument and return types below. |
Promise<DrawingsChangeEventDetail | null> | An asynchronous method. Check the argument and return types below. | |
Promise<DrawingsChangeEventDetail | null> | An asynchronous method. Check the argument and return types below. | |
Promise<DrawingsChangeEventDetail | null> | An asynchronous method. Check the argument and return types below. | |
Promise<string> | An asynchronous method. Check the argument and return types below. | |
| input: ChartDrawingsInput | Promise<DrawingsChangeEventDetail | null> | An asynchronous method. Check the argument and return types below. |
Promise<DrawingLayerSnapshot | null> | An asynchronous method. Check the argument and return types below. | |
Promise<void> | An asynchronous method. Check the argument and return types below. | |
| file: Blob | string | Promise<DrawingsChangeEventDetail | null> | An asynchronous method. Check the argument and return types below. |
| ids: ReadonlyArray<string> | null | Promise<DrawingSelectionChangeEventDetail | null> | An asynchronous method. Check the argument and return types below. |
Promise<string[]> | An asynchronous method. Check the argument and return types below. | |
| binding: VisualMapBinding | null | Promise<VisualMapBinding | null> | An asynchronous method. Check the argument and return types below. |
Promise<VisualMapBinding | null> | An asynchronous method. Check the argument and return types below. | |
| request?: VisualMapExtentRequest | Promise<VisualMapExtent | null> | An asynchronous method. Check the argument and return types below. |
Promise<{ id: string | undefined; dimensions: ReadonlyArray<{ index: number; name: string; type: string }>; rows: ReadonlyArray<ReadonlyArray<unknown>> } | null> | An asynchronous method. Check the argument and return types below. | |
Promise<EncodedDataset | null> | An asynchronous method. Check the argument and return types below. | |
| action: ChartAction | string | Promise<ChartActionResult> | One entry point over the imperative surface (ECharts `dispatchAction`): `{ type, payload }` or `{ type, ...fields }`. Routes to the method behind the type and answers `{ type, handled, result }`; an unknown type is reported, not thrown. |
| samples: ArrayLike<number> | Promise<SpectrogramAppendSamplesResult> | An asynchronous method. Check the argument and return types below. |
Promise<void> | An asynchronous method. Check the argument and return types below. | |
| cssX: number, cssY: number | Promise<{ pointIndex: number; seriesIndex: number } | null> | An asynchronous method. Check the argument and return types below. |
No matching APIs.