Methods

Complete list

• getFlowLinesData

  An asynchronous method. Check the argument and return types below.

• getFlowLinesLayout

  An asynchronous method. Check the argument and return types below.

• getFlowLinesDiagnostics

  An asynchronous method. Check the argument and return types below.

• selectFlowLines

  An asynchronous method. Check the argument and return types below.

• showFlowLinesTooltip

  An asynchronous method. Check the argument and return types below.

• clearFlowLinesStream

  An asynchronous method. Check the argument and return types below.

• recycleFlowLinesGpu

  An asynchronous method. Check the argument and return types below.

• getThemeRiverData

  An asynchronous method. Check the argument and return types below.

• getThemeRiverLayout

  An asynchronous method. Check the argument and return types below.

• getThemeRiverDiagnostics

  An asynchronous method. Check the argument and return types below.

• selectThemeRiverPoint

  An asynchronous method. Check the argument and return types below.

• showThemeRiverTooltip

  An asynchronous method. Check the argument and return types below.

• showThemeRiverCrosshair

  An asynchronous method. Check the argument and return types below.

• clearThemeRiverStream

  An asynchronous method. Check the argument and return types below.

• recycleThemeRiverGpu

  An asynchronous method. Check the argument and return types below.

• getBar3DData

  Surface grid coordinates are row/column; generic tooltip methods use a row-major sample index.

• getScatter3DData

  An asynchronous method. Check the argument and return types below.

• getBar3DLayout

  An asynchronous method. Check the argument and return types below.

• getScatter3DLayout

  An asynchronous method. Check the argument and return types below.

• getBar3DDiagnostics

  An asynchronous method. Check the argument and return types below.

• getScatter3DDiagnostics

  An asynchronous method. Check the argument and return types below.

• selectBar3DPoint

  An asynchronous method. Check the argument and return types below.

• selectScatter3DPoint

  An asynchronous method. Check the argument and return types below.

• showBar3DTooltip

  An asynchronous method. Check the argument and return types below.

• showScatter3DTooltip

  An asynchronous method. Check the argument and return types below.

• showBar3DCrosshair

  An asynchronous method. Check the argument and return types below.

• showScatter3DCrosshair

  An asynchronous method. Check the argument and return types below.

• getSurface3DData

  An asynchronous method. Check the argument and return types below.

• getSurface3DLayout

  An asynchronous method. Check the argument and return types below.

• getSurface3DDiagnostics

  An asynchronous method. Check the argument and return types below.

• selectSurface3DPoint

  An asynchronous method. Check the argument and return types below.

• showSurface3DTooltip

  An asynchronous method. Check the argument and return types below.

• showSurface3DCrosshair

  An asynchronous method. Check the argument and return types below.

• getCamera3D

  An asynchronous method. Check the argument and return types below.

• setCamera3D

  An asynchronous method. Check the argument and return types below.

• setProjection3D

  An asynchronous method. Check the argument and return types below.

• fitCamera3D

  An asynchronous method. Check the argument and return types below.

• resetCamera3D

  An asynchronous method. Check the argument and return types below.

• saveCamera3D

  An asynchronous method. Check the argument and return types below.

• rotate3D

  An asynchronous method. Check the argument and return types below.

• pan3D

  Pan the 3D camera in CSS pixels; use zoomBy for camera distance/orthographic zoom.

• recycleGpu3D

  An asynchronous method. Check the argument and return types below.

• clearBar3DStream

  An asynchronous method. Check the argument and return types below.

• clearScatter3DStream

  An asynchronous method. Check the argument and return types below.

• clearSurface3DStream

  An asynchronous method. Check the argument and return types below.

• getDataTable

  Resolves the data table for the current data ( / 134). Waits for the type's load answer and rejects with a ChartLoadError (its code = the status) when the type cannot be drawn here: no table is invented for it. A Pro chart type's table comes from its element only (the facade carries no Pro data resolvers).

• getCSV

  Returns the chart data as a CSV string (UTF-8 BOM, RFC 4180).

• getSVG

  Returns the chart as standalone SVG markup (canvas families wrap their raster); the drawing overlay rides along as a nested layer, and the brand is the last layer over everything. Keeps its string | null contract: null when the type cannot be drawn here (see getDataTable) or there is no surface yet.

• exportCSV

  Downloads the chart data as a CSV file (). Data only: no brand. Rejects like getDataTable when the type cannot be drawn.

• exportSVG

  Downloads the chart as an SVG file (). Rejects with a ChartLoadError when the type cannot be drawn here.

• exportPNG

  Downloads the chart as a PNG file at exportScale (). Rejects with a ChartLoadError when the type cannot be drawn here.

• print

  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.

• setContextMenuEnabled

  Enables or disables the shared right-click context menu at runtime.

• openContextMenu

  Opens the shared context menu at chart-local coordinates, or the chart centre when omitted.

• closeContextMenu

  Closes the shared context menu.

• showDataTable

  Opens the accessible data table dialog ().

• hideDataTable

  Closes the accessible data table dialog.

• redraw

  Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves.

• getYield

  Wafer map: pass/fail/yield summary over the probed dies (null on other types).

• getValueStats

  Wafer map: statistics over the measured die values (null on other types).

• getDefectSummary

  Wafer map: per-class defect summary (null on other types).

• getShotOf

  Wafer map: shot (reticle) coordinate of a lattice cell (null on other types).

• hitTestDie

  Wafer map: die under a component-local CSS point (null off-die or on other types).

• selectDie

  Wafer map: select a die programmatically (null off-lattice or on other types).

• clearDieSelection

  Wafer map: clear the die selection.

• getSelectedDie

  Wafer map: the current die selection (null when none or on other types).

• appendDie

  Wafer map: stream one probe result in (cell upsert; re-tests emit binChanged).

• updateDie

  Wafer map: patch one die's data (creates the cell when absent).

• getDieIndex

  Wafer map: map index of a notch-frame lattice cell (null off-wafer or on other types).

• getDieByIndex

  Wafer map: die entry addressed by its map index (null off-wafer or on other types).

• getRunningTotal

  The waterfall's running total after its last step (the value a total bar stands to); undefined on any other type.

• getTypeLoadState

  The chart type's current load answer : status, tag, entitlement state, reason and attempt.

• whenTypeReady

  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.

• retryTypeLoad

  Asks for the chart type again (a new attempt), e.g. after load-failed; resolves with the settled answer.

• getEngineStatus

  The engine behind the chart : 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.

• getActiveTier

  An asynchronous method. Check the argument and return types below.

• setData

  Replace the bar set.

• addSeries

  An asynchronous method. Check the argument and return types below.

• removeSeries

  An asynchronous method. Check the argument and return types below.

• updateSeries

  An asynchronous method. Check the argument and return types below.

• updatePoint

  Radar-only — patch one category value in a series.

• setSeriesData

  An asynchronous method. Check the argument and return types below.

• addPointToSeries

  An asynchronous method. Check the argument and return types below.

• showSeries

  An asynchronous method. Check the argument and return types below.

• hideSeries

  An asynchronous method. Check the argument and return types below.

• appendPoint

  Append one value to the stream. Check the argument type and the licensing requirements for streaming.

• appendBatch

  Append multiple values to the stream. Check the argument type and the licensing requirements for streaming.

• shift

  Drop the oldest streamed categories (the data boxes are not the stream).

• replace

  Swap the streamed set (replace([]) clears it); the base values never leave. Without chart.streaming the dies upsert into the base like a batch (quietly: no appended, no binChanged, as a ring replace).

• getStreamSource

  The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed.

• setAnimation

  An asynchronous method. Check the argument and return types below.

• pauseAnimation

  Pause the current animation.

• resumeAnimation

  Resume a paused animation.

• replayAnimation

  Pie / gauge — replay the initial reveal (pie sweep-from-zero, gauge sweep-from-min).

• setValue

  Gauge-only — set the primary value.

• getValue

  Gauge-only — read the current primary value.

• addNeedle

  Gauge-only — add a needle (dial variant).

• removeNeedle

  Gauge-only — remove a needle by id or index.

• updateNeedle

  Gauge-only — patch a needle.

• addSection

  Funnel / pyramid-only — add a section (stage). Returns its index.

• removeSection

  Funnel / pyramid-only — remove a section by id or index.

• updateSection

  Funnel / pyramid-only — patch a section.

• hitTest

  Radar / funnel / pyramid — hit-test the polar/radial SVG at chart-local coordinates.

• showRadarTooltipAt

  Radar-only — open a vertex tooltip by series/category index.

• showSectionTooltipAt

  Funnel / pyramid-only — open a section tooltip by id or index.

• hitTestGauge

  Gauge-only — hit-test the dial at canvas coordinates.

• showGaugeTooltip

  Gauge-only — open the value tooltip programmatically.

• showTooltipAtValue

  Gauge-only — open the value tooltip at a specific value's angle (analogue of showTooltipAtSlice).

• setRings

  Gauge-only (activity) — replace the ring set.

• setRingValue

  Gauge-only (activity) — update one ring's value by id, name, or index.

• selectNodeAt

  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.

• selectRowAt

  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.

• getRows

  An asynchronous method. Check the argument and return types below.

• getRow

  An asynchronous method. Check the argument and return types below.

• getRowById

  An asynchronous method. Check the argument and return types below.

• getRowCount

  An asynchronous method. Check the argument and return types below.

• getParallelCoordinatesLayout

  An asynchronous method. Check the argument and return types below.

• setParallelCoordinatesBrushes

  An asynchronous method. Check the argument and return types below.

• setParallelCoordinatesAxisBrush

  An asynchronous method. Check the argument and return types below.

• clearParallelCoordinatesBrushes

  An asynchronous method. Check the argument and return types below.

• getParallelCoordinatesBrushes

  An asynchronous method. Check the argument and return types below.

• getParallelCoordinatesBrushedRows

  An asynchronous method. Check the argument and return types below.

• getParallelCoordinatesBrushModels

  An asynchronous method. Check the argument and return types below.

• getParallelCoordinatesLineModels

  An asynchronous method. Check the argument and return types below.

• getParallelCoordinatesAxisModels

  An asynchronous method. Check the argument and return types below.

• getParallelCoordinatesAxes

  An asynchronous method. Check the argument and return types below.

• getParallelCoordinatesDiagnostics

  An asynchronous method. Check the argument and return types below.

• selectTaskAt

  An asynchronous method. Check the argument and return types below.

• getTasks

  An asynchronous method. Check the argument and return types below.

• getTask

  An asynchronous method. Check the argument and return types below.

• getTaskById

  An asynchronous method. Check the argument and return types below.

• getTaskCount

  An asynchronous method. Check the argument and return types below.

• getGanttExtent

  An asynchronous method. Check the argument and return types below.

• getGanttLayout

  An asynchronous method. Check the argument and return types below.

• getGanttDiagnostics

  An asynchronous method. Check the argument and return types below.

• getGanttLabels

  An asynchronous method. Check the argument and return types below.

• getGanttBaselines

  An asynchronous method. Check the argument and return types below.

• getGanttTaskEdits

  An asynchronous method. Check the argument and return types below.

• resetGanttTaskEdits

  An asynchronous method. Check the argument and return types below.

• cancelGanttTaskEdit

  An asynchronous method. Check the argument and return types below.

• getGanttCriticalPath

  An asynchronous method. Check the argument and return types below.

• getGanttDependencies

  An asynchronous method. Check the argument and return types below.

• getGanttDependencyPaths

  An asynchronous method. Check the argument and return types below.

• getGanttDependencySelection

  An asynchronous method. Check the argument and return types below.

• selectGanttDependencyAt

  An asynchronous method. Check the argument and return types below.

• hitTestGanttDependency

  An asynchronous method. Check the argument and return types below.

• showGanttDependencyTooltipAtIndex

  An asynchronous method. Check the argument and return types below.

• getGanttTimeAxis

  An asynchronous method. Check the argument and return types below.

• drillTo

  Enter a structural branch by stable ID; null returns to the complete forest. Requires drilldown.

• drillDown

  Treemap: enter a branch by its normalized data index. Requires drilldown.

• drillUp

  Treemap: return to the parent branch, then the forest.

• getDrillRoot

  Treemap: current branch with its original identity and index, or null for the forest.

• selectLinkAt

  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.

• clearSelection

  Sankey / Chord / Network Graph — release selection (a no-op on other types).

• pinNode

  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.

• unpinNode

  Network Graph — release a pinned node; false on other types or when it was not pinned.

• clearPinnedNodes

  Network Graph — release every pinned node; the count released.

• getPinnedNodes

  Network Graph — the pinned nodes at their applied positions; empty on other types.

• getSelection

  The selection: the selected node's / link's detail (null = none); its anchors are Pro-derived, refused without a valid license.

• selectSlice

  Pie-only — select a slice by id or index.

• deselectSlice

  Pie-only — clear selection on a slice.

• getSelectedSlices

  Pie-only — read the current selection set.

• hitTestSlice

  Pie-only — hit-test slice at canvas-relative coordinates.

• showTooltipAtSlice

  Pie-only — programmatic tooltip open.

• addParty

  Item-only — add a party (datum) to the parliament.

• removeParty

  Item-only — remove a party by id, name, or index.

• updateParty

  Item-only — patch a party's datum fields.

• setPartySeats

  Item-only — set a party's seat count.

• hitTestSeat

  Item-only — hit-test the seat dot at canvas-relative coordinates.

• showTooltipAtParty

  Item-only — programmatic tooltip open on a party.

• addWord

  Word-cloud-only — add a word datum.

• removeWord

  Word-cloud-only — remove a word by id, name, or index.

• updateWord

  Word-cloud-only — patch a word's datum fields.

• setWordWeight

  Word-cloud-only — set a word's weight.

• hitTestWord

  Word-cloud-only — hit-test the word at canvas-relative coordinates.

• getDroppedWords

  Word-cloud-only — words the spiral could not fit inside the plot.

• showTooltipAtWord

  Word-cloud-only — programmatic tooltip open on a word.

• addTile

  Tilemap-only — append a tile datum (occupied cells update in place).

• removeTile

  Tilemap-only — remove a tile by id, name, index, or {x, y} cell.

• updateTile

  Tilemap-only — patch a tile's datum fields.

• setTileValue

  Tilemap-only — set a tile's metric value.

• hitTestTile

  Tilemap-only — hit-test the tile at canvas-relative coordinates.

• showTooltipAtTile

  Tilemap-only — programmatic tooltip open on a tile.

• hitTestLeaf

  Stem-leaf-only — hit-test the leaf at canvas-relative coordinates.

• showTooltipAtLeaf

  Stem-leaf-only — programmatic tooltip open on a leaf by source index.

• hitTestSegment

  Polar-only — hit-test the rose segment at canvas-relative coordinates.

• showTooltipAtSegment

  Polar-only — programmatic tooltip open on a (direction, series) cell.

• hitTestMarker

  An asynchronous method. Check the argument and return types below.

• hitTestMarkers

  An asynchronous method. Check the argument and return types below.

• showTooltipAtPoint

  Open the tooltip for a dot programmatically. pointIndex is the category (row) index; the optional seriesIndex selects a group within that row (defaults to the first visible group's dot in the row). Returns the emitted tooltip detail, or null when no dot resolves / the tooltip is disabled.

• zoomTo

  zoom the active cartesian family to explicit windows (x / y, xAxis / yAxis). Non-cartesian types resolve null.

• zoomBy

  scale the active cartesian family's windows by factor (< 1 zooms in) around anchorFraction.

• panBy

  slide the active cartesian family's zoomed windows by data units ({ x?, y? }).

• resetZoom

  Reset the zoomed or panned range to the original data range.

• resetMapView

  Geo Map: restore the configured projection/region and clear viewport zoom.

• parseTopoJSON

  Geo Map: decode TopoJSON without changing data. Returns null for other chart types or an unavailable child.

• parseGeoJSON

  Geo Map: decode RFC 7946 GeoJSON without changing data. Returns null for other types or an unavailable child.

• setFeatures

  Geo Map: atomically validate and replace the polygon layer.

• getFeatures

  An asynchronous method. Check the argument and return types below.

• getMapHeat

  An asynchronous method. Check the argument and return types below.

• getMapLayers

  An asynchronous method. Check the argument and return types below.

• setMapLayerVisible

  Immediately mask a layer without restarting active animations, rescaling or reframing. Unknown keys return null.

• fitMap

  Fit current point/feature geometry with a uniform scale. Empty candidates leave the view unchanged.

• getMapLabels

  Full source text and current screen placement for both point and feature names.

• getMapView

  Owned geographic camera, effective region and viewport state.

• getMapHeatAt

  Read aggregate density at a host-relative point; original point/feature selection remains separate.

• getMapHeatAtCoordinate

  Current visible density at longitude/latitude; null when hidden, clipped or outside the viewport.

• getMapBubbleScale

  An asynchronous method. Check the argument and return types below.

• getMapColorAxis

  An asynchronous method. Check the argument and return types below.

• getMapDiagnostics

  Current Geo Map normalization counters; null for another type or an absent child.

• getMapAvailability

  Geo Map requested/active engine, asynchronous readiness and unavailable reason; null for other families or a missing child.

• selectFeatureAt

  An asynchronous method. Check the argument and return types below.

• getFeatureSelection

  An asynchronous method. Check the argument and return types below.

• showTooltipAtFeature

  An asynchronous method. Check the argument and return types below.

• getZoom

  Read the current zoom range. Check the return type's nullability and the range for each axis.

• getZoomExtent

  the active cartesian family's full axis extents (for range controls such as sy-data-zoom).

• connect

  link this chart's zoom / pan with other charts (elements or ids in this chart's root): every member's zoomChange reaches the others as zoomTo({ source: 'sync' }) on the axes (default 'x'). A newcomer is aligned to this chart. Calling again replaces the link.

• disconnect

  drop the link made by connect (the charts keep their windows).

• showCrosshairAt

  show the active cartesian family's crosshair at a data position (no crosshairMove); false outside the plot.

• hideCrosshair

  hide the crosshair.

• setBrush

  replace the brush areas of the active cartesian family (null clears).

• clearBrush

  clear the brush areas.

• getBrush

  the persisted brush areas (primary data space).

• getBrushSelection

  the points inside the brush areas, per series.

• getDrawings

  the drawing document of the active cartesian family.

• setDrawings

  replace the drawing document (null clears; undoable).

• addDrawing

  add one drawing (an explicit id replaces).

• updateDrawing

  merge a patch into one drawing.

• removeDrawing

  remove one drawing.

• removeDrawings

  remove several drawings in one undoable step.

• setDrawingSpace

  move a drawing to the other coordinate space (its anchors convert at the current frame).

• clearDrawings

  clear the drawing document (undoable).

• undoDrawing

  undo the last drawing change.

• redoDrawing

  redo the last undone drawing change.

• exportDrawings

  the drawing document as its JSON envelope.

• importDrawings

  replace the drawing document from an envelope / list / JSON string.

• getDrawingLayer

  the drawing overlay as a positioned SVG layer (null without drawings): what getSVG / exportSVG / exportPNG compose into the image.

• exportDrawingsFile

  downloads the drawing document as <export name>-drawings.json (the envelope importDrawings / importDrawingsFile read back); reports through exported.

• importDrawingsFile

  replaces the drawing document from a picked file (a File / Blob of the envelope, or its text); a file that is not JSON is declined (null) and the document stays.

• selectDrawings

  select drawings (null clears).

• getDrawingSelection

  the selected drawing ids.

• setVisualMap

  bind (or clear) a visual map on the cartesian family that owns the paint.

• getVisualMap

  An asynchronous method. Check the argument and return types below.

• getVisualExtent

  the extent of a dimension over the visible points (the domain a bound sy-visual-map adopts).

• getDataset

  the dataset after its transforms (id, dimensions, rows), or null without a dataset.

• getEncodedSeries

  the encoded series (names, values, xValues, the dimension names behind them) and the category labels, or null.

• dispatchAction

  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.

• appendSamples

  feed raw samples: every completed window becomes a frame (appended through the stream); the rest waits.

• hideTooltip

  Close the currently visible tooltip.

• hitTestScatterPoint

  An asynchronous method. Check the argument and return types below.