sy-parallel-coordinates

Parallel Coordinates

Connect an observation's multiple metrics with one line.

sy-parallel-coordinates

Compare multidimensional patterns across products or observation groups.

Check units and axis directions. Use brushing to focus on a range when there are many lines.

Base chart tier: Pro. Features such as additional renderers and custom branding have separate entitlement requirements.

InputData description
dataAn array of { id, label?, values: { dimensionId: number } }.
dimensionsEach axis's id, label, domain, and scale.

Complete implementation example

html
<div id="chart-container" style="width: 100%; min-width: 0;"></div>

<script type="module">
  import { defineCustomElement as define0 } from '@syidax/advanced-pro/components/sy-parallel-coordinates.js';
  define0();

  // Pro: complete registerLicense at app startup using your issued certificate.
  // The website preview certificate is not for use in customer apps.
  const specs = [
    {
      "id": "example-chart",
      "tag": "sy-parallel-coordinates",
      "props": {
        "data": [
          {
            "id": "a",
            "label": "Product A",
            "color": "#8263d9",
            "values": {
              "price": 30,
              "quality": 90,
              "speed": 65,
              "support": 80
            }
          },
          {
            "id": "b",
            "label": "Product B",
            "color": "#239c91",
            "values": {
              "price": 65,
              "quality": 75,
              "speed": 90,
              "support": 60
            }
          },
          {
            "id": "c",
            "label": "Product C",
            "color": "#e99954",
            "values": {
              "price": 45,
              "quality": 70,
              "speed": 75,
              "support": 95
            }
          }
        ],
        "dimensions": [
          {
            "id": "price",
            "label": "Price",
            "domain": [0, 100]
          },
          {
            "id": "quality",
            "label": "Quality",
            "domain": [0, 100]
          },
          {
            "id": "speed",
            "label": "Speed",
            "domain": [0, 100]
          },
          {
            "id": "support",
            "label": "Support",
            "domain": [0, 100]
          }
        ],
        "width": 640,
        "height": 360,
        "brandPosition": "bottom-right",
        "brandLogo": ""
      }
    }
  ];
  const container = document.querySelector('#chart-container');
  const elements = specs.map(({ tag, id, props }) => {
    const element = document.createElement(tag);
    element.id = id;
    Object.assign(element, props);
    element.setAttribute('aria-label', 'parallel-coordinates example chart');
    return element;
  });
  container.replaceChildren(...elements);
  const chart = elements.at(-1);
  const onEvent = event => {
    console.log('rowClick', event.detail);
  };
  chart.addEventListener('rowClick', onEvent);
  const observer = new ResizeObserver(([entry]) => {
    const width = Math.max(160, Math.floor(entry.contentRect.width));
    elements.forEach(element => { element.width = width; });
  });
  observer.observe(container);

  // In an SPA, call this function when the view is disposed.
  function disposeChart() {
    observer.disconnect();
    chart.removeEventListener('rowClick', onEvent);
    container.replaceChildren();
  }
</script>

Properties

data

An array of { id, label?, values: { dimensionId: number } }.

ItemValue
JavaScript propertydata
HTML attributePass objects, arrays, and callbacks as JavaScript properties
TypeParallelCoordinatesData
Defaultundefined

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

width

Chart width in pixels. If the container width changes, update width from a ResizeObserver.

ItemValue
JavaScript propertywidth
HTML attributewidth
Typenumber
Default900

height

Chart height in pixels. Allow space for axes, titles, and the legend.

ItemValue
JavaScript propertyheight
HTML attributeheight
Typenumber
Default400

brandPosition

The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports.

ItemValue
JavaScript propertybrandPosition
HTML attributebrand-position
Type'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'
Default'bottom-right'
Allowed valuestop-left, top-right, bottom-left, bottom-right

dimensions

Each axis's id, label, domain, and scale.

ItemValue
JavaScript propertydimensions
HTML attributePass objects, arrays, and callbacks as JavaScript properties
TypeReadonlyArray<ParallelCoordinatesDimensionInput>
Defaultundefined

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

lineWidth

Set as an HTML attribute or JavaScript property. type: number.

ItemValue
JavaScript propertylineWidth
HTML attributeline-width
Typenumber
Default1.5

lineOpacity

Set as an HTML attribute or JavaScript property. type: number.

ItemValue
JavaScript propertylineOpacity
HTML attributeline-opacity
Typenumber
Default.65

lineDash

Pass as a JavaScript property. type: ReadonlyArray<number>|string.

ItemValue
JavaScript propertylineDash
HTML attributePass objects, arrays, and callbacks as JavaScript properties
TypeReadonlyArray<number>|string
Default[]

connectNulls

Set as an HTML attribute or JavaScript property. type: boolean.

ItemValue
JavaScript propertyconnectNulls
HTML attributeconnect-nulls
Typeboolean
Defaultfalse

inactiveRowOpacity

Set as an HTML attribute or JavaScript property. type: number.

ItemValue
JavaScript propertyinactiveRowOpacity
HTML attributeinactive-row-opacity
Typenumber
Default.25

color

Set as an HTML attribute or JavaScript property. type: string.

ItemValue
JavaScript propertycolor
HTML attributecolor
Typestring
Default'auto'

activeColor

Set as an HTML attribute or JavaScript property. type: string.

ItemValue
JavaScript propertyactiveColor
HTML attributeactive-color
Typestring
Default'#f59e0b'

axisLabels

Set as an HTML attribute or JavaScript property. type: boolean.

ItemValue
JavaScript propertyaxisLabels
HTML attributeaxis-labels
Typeboolean
Defaulttrue

axes

Pass as a JavaScript property. type: ParallelCoordinatesAxesInput.

ItemValue
JavaScript propertyaxes
HTML attributePass objects, arrays, and callbacks as JavaScript properties
TypeParallelCoordinatesAxesInput
Defaultundefined

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

axisBrush

Pass as a JavaScript property. type: ParallelCoordinatesBrushInput.

ItemValue
JavaScript propertyaxisBrush
HTML attributePass objects, arrays, and callbacks as JavaScript properties
TypeParallelCoordinatesBrushInput
Defaultundefined

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

chartTitle

The title inside the chart. Explain the data's unit and meaning alongside it.

ItemValue
JavaScript propertychartTitle
HTML attributechart-title
Typestring
Defaultundefined

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

chartSubtitle

The subtitle inside the chart.

ItemValue
JavaScript propertychartSubtitle
HTML attributechart-subtitle
Typestring
Defaultundefined

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

enableMouseTracking

Set as an HTML attribute or JavaScript property. type: boolean.

ItemValue
JavaScript propertyenableMouseTracking
HTML attributeenable-mouse-tracking
Typeboolean
Defaulttrue

tooltip

Tooltip settings for pointer-driven values, position, and content.

ItemValue
JavaScript propertytooltip
HTML attributePass objects, arrays, and callbacks as JavaScript properties
TypeCartesianTooltipInput
Defaultundefined
Literals in the typeauto, off

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

tooltipEnabled

Set as an HTML attribute or JavaScript property. type: boolean.

ItemValue
JavaScript propertytooltipEnabled
HTML attributetooltip-show
Typeboolean
Defaulttrue

tooltipFormat

Pass as a JavaScript property. type: (detail: ParallelCoordinatesHitDetail) => string.

ItemValue
JavaScript propertytooltipFormat
HTML attributePass objects, arrays, and callbacks as JavaScript properties
Type(detail: ParallelCoordinatesHitDetail) => string
Defaultundefined

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

animated

Whether to animate initial display and data changes.

ItemValue
JavaScript propertyanimated
HTML attributeanimate
Typeboolean
Defaultfalse

animationDuration

Animation duration in milliseconds.

ItemValue
JavaScript propertyanimationDuration
HTML attributeanimation-duration
Typenumber
Default600

animationEasing

Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'.

ItemValue
JavaScript propertyanimationEasing
HTML attributeanimation-easing
TypeParallelCoordinatesEasing
Default'ease-out'
Allowed valueslinear, ease-out, ease-in, ease-in-out

animationType

Allowed values: initial, update. Default: undefined.

ItemValue
JavaScript propertyanimationType
HTML attributeanimation-type
TypeParallelCoordinatesAnimationType
Defaultundefined
Allowed valuesinitial, update

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

streamSource

A stream source for live data. Check the contract for the specific type.

ItemValue
JavaScript propertystreamSource
HTML attributePass objects, arrays, and callbacks as JavaScript properties
TypeParallelCoordinatesStreamSource
Defaultundefined

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

streamMax

The maximum number of streaming data points to retain.

ItemValue
JavaScript propertystreamMax
HTML attributestream-max
Typenumber
Defaultundefined

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

streamWindow

The streaming data range to keep visible.

ItemValue
JavaScript propertystreamWindow
HTML attributestream-window
Typenumber
Defaultundefined

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

zoom

Settings for zooming and the visible range.

ItemValue
JavaScript propertyzoom
HTML attributePass objects, arrays, and callbacks as JavaScript properties
TypeCartesianZoomInput
Defaultundefined
Literals in the typeauto, off, true, false, x, y, xy, inside

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

crosshair

Pass as a JavaScript property. type: CartesianCrosshairInput.

ItemValue
JavaScript propertycrosshair
HTML attributePass objects, arrays, and callbacks as JavaScript properties
TypeCartesianCrosshairInput
Defaultundefined

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

engine

Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type.

ItemValue
JavaScript propertyengine
HTML attributeengine
TypeParallelCoordinatesEngineMode
Default'auto'
Allowed valuesauto, standard, pro

unavailable

Allowed values: fallback, error. Default: 'fallback'.

ItemValue
JavaScript propertyunavailable
HTML attributeunavailable
TypeParallelCoordinatesUnavailableBehaviour
Default'fallback'
Allowed valuesfallback, error

Events

rendered

Emits rendering results in detail when chart drawing completes.

Event name: rendered. Names are case-sensitive. Read the payload from detail on CustomEvent<ParallelCoordinatesRenderResult & { tier: ParallelCoordinatesEngineTier }>.

javascript
chart.addEventListener('rendered', event => {
  console.log(event.detail); // ParallelCoordinatesRenderResult & { tier: ParallelCoordinatesEngineTier }
});

rowClick

CustomEvent.detail type: ParallelCoordinatesHitDetail. Event names are case-sensitive.

Event name: rowClick. Names are case-sensitive. Read the payload from detail on CustomEvent<ParallelCoordinatesHitDetail>.

javascript
chart.addEventListener('rowClick', event => {
  console.log(event.detail); // ParallelCoordinatesHitDetail
});

rowHover

CustomEvent.detail type: ParallelCoordinatesHitDetail | null. Event names are case-sensitive.

Event name: rowHover. Names are case-sensitive. Read the payload from detail on CustomEvent<ParallelCoordinatesHitDetail | null>.

javascript
chart.addEventListener('rowHover', event => {
  console.log(event.detail); // ParallelCoordinatesHitDetail | null
});

selectionChanged

CustomEvent.detail type: ParallelCoordinatesSelectionChangeEventDetail. Event names are case-sensitive.

Event name: selectionChanged. Names are case-sensitive. Read the payload from detail on CustomEvent<ParallelCoordinatesSelectionChangeEventDetail>.

javascript
chart.addEventListener('selectionChanged', event => {
  console.log(event.detail); // ParallelCoordinatesSelectionChangeEventDetail
});

pointContextMenu

CustomEvent.detail type: ChartPointContextMenuEventDetail<ParallelCoordinatesHitDetail>. Event names are case-sensitive.

Event name: pointContextMenu. Names are case-sensitive. Read the payload from detail on CustomEvent<ChartPointContextMenuEventDetail<ParallelCoordinatesHitDetail>>.

javascript
chart.addEventListener('pointContextMenu', event => {
  console.log(event.detail); // ChartPointContextMenuEventDetail<ParallelCoordinatesHitDetail>
});

appended

CustomEvent.detail type: { count: number; replaced: number }. Event names are case-sensitive.

Event name: appended. Names are case-sensitive. Read the payload from detail on CustomEvent<{ count: number; replaced: number }>.

javascript
chart.addEventListener('appended', event => {
  console.log(event.detail); // { count: number; replaced: number }
});

windowSlid

CustomEvent.detail type: { dropped: number }. Event names are case-sensitive.

Event name: windowSlid. Names are case-sensitive. Read the payload from detail on CustomEvent<{ dropped: number }>.

javascript
chart.addEventListener('windowSlid', event => {
  console.log(event.detail); // { dropped: number }
});

tooltipShow

Whether to display the built-in tooltip.

Event name: tooltipShow. Names are case-sensitive. Read the payload from detail on CustomEvent<CartesianTooltipEventDetail>.

javascript
chart.addEventListener('tooltipShow', event => {
  console.log(event.detail); // CartesianTooltipEventDetail
});

tooltipHide

CustomEvent.detail type: void. Event names are case-sensitive.

Event name: tooltipHide. Names are case-sensitive. Read the payload from detail on CustomEvent<void>.

javascript
chart.addEventListener('tooltipHide', event => {
  console.log(event.detail); // void
});

tooltipAction

CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive.

Event name: tooltipAction. Names are case-sensitive. Read the payload from detail on CustomEvent<CartesianTooltipActionEventDetail>.

javascript
chart.addEventListener('tooltipAction', event => {
  console.log(event.detail); // CartesianTooltipActionEventDetail
});

chartAnimationStart

CustomEvent.detail type: void. Event names are case-sensitive.

Event name: chartAnimationStart. Names are case-sensitive. Read the payload from detail on CustomEvent<void>.

javascript
chart.addEventListener('chartAnimationStart', event => {
  console.log(event.detail); // void
});

chartAnimationEnd

CustomEvent.detail type: void. Event names are case-sensitive.

Event name: chartAnimationEnd. Names are case-sensitive. Read the payload from detail on CustomEvent<void>.

javascript
chart.addEventListener('chartAnimationEnd', event => {
  console.log(event.detail); // void
});

chartAnimationInterrupted

CustomEvent.detail type: void. Event names are case-sensitive.

Event name: chartAnimationInterrupted. Names are case-sensitive. Read the payload from detail on CustomEvent<void>.

javascript
chart.addEventListener('chartAnimationInterrupted', event => {
  console.log(event.detail); // void
});

zoomChange

CustomEvent.detail type: CartesianZoomChangeEventDetail. Event names are case-sensitive.

Event name: zoomChange. Names are case-sensitive. Read the payload from detail on CustomEvent<CartesianZoomChangeEventDetail>.

javascript
chart.addEventListener('zoomChange', event => {
  console.log(event.detail); // CartesianZoomChangeEventDetail
});

axisBrushChange

CustomEvent.detail type: ParallelCoordinatesBrushChangeEventDetail. Event names are case-sensitive.

Event name: axisBrushChange. Names are case-sensitive. Read the payload from detail on CustomEvent<ParallelCoordinatesBrushChangeEventDetail>.

javascript
chart.addEventListener('axisBrushChange', event => {
  console.log(event.detail); // ParallelCoordinatesBrushChangeEventDetail
});

axisBrushStart

CustomEvent.detail type: ParallelCoordinatesBrushGestureEventDetail. Event names are case-sensitive.

Event name: axisBrushStart. Names are case-sensitive. Read the payload from detail on CustomEvent<ParallelCoordinatesBrushGestureEventDetail>.

javascript
chart.addEventListener('axisBrushStart', event => {
  console.log(event.detail); // ParallelCoordinatesBrushGestureEventDetail
});

axisBrushMove

CustomEvent.detail type: ParallelCoordinatesBrushGestureEventDetail. Event names are case-sensitive.

Event name: axisBrushMove. Names are case-sensitive. Read the payload from detail on CustomEvent<ParallelCoordinatesBrushGestureEventDetail>.

javascript
chart.addEventListener('axisBrushMove', event => {
  console.log(event.detail); // ParallelCoordinatesBrushGestureEventDetail
});

axisBrushEnd

CustomEvent.detail type: ParallelCoordinatesBrushGestureEventDetail. Event names are case-sensitive.

Event name: axisBrushEnd. Names are case-sensitive. Read the payload from detail on CustomEvent<ParallelCoordinatesBrushGestureEventDetail>.

javascript
chart.addEventListener('axisBrushEnd', event => {
  console.log(event.detail); // ParallelCoordinatesBrushGestureEventDetail
});

crosshairMove

CustomEvent.detail type: ParallelCoordinatesCrosshairDetail|null. Event names are case-sensitive.

Event name: crosshairMove. Names are case-sensitive. Read the payload from detail on CustomEvent<ParallelCoordinatesCrosshairDetail|null>.

javascript
chart.addEventListener('crosshairMove', event => {
  console.log(event.detail); // ParallelCoordinatesCrosshairDetail|null
});

Methods

redraw

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

typescript
redraw(): Promise<ParallelCoordinatesRenderResult>

Return type: Promise<ParallelCoordinatesRenderResult>. Call the method after element registration and await its Promise result.

getEngineStatus

Requested engine vs what runs, and why (CHART-ADD-08); a frozen or unlicensed chart reports the license outcome.

typescript
getEngineStatus(): Promise<ChartEngineStatus>

Return type: Promise<ChartEngineStatus>. Call the method after element registration and await its Promise result.

getActiveTier

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

typescript
getActiveTier(): Promise<ParallelCoordinatesEngineTier>

Return type: Promise<ParallelCoordinatesEngineTier>. Call the method after element registration and await its Promise result.

getUnavailableReason

Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back.

typescript
getUnavailableReason(): Promise<string | undefined>

Return type: Promise<string | undefined>. Call the method after element registration and await its Promise result.

setData

Replace the bar set.

typescript
setData(data: ParallelCoordinatesData): Promise<void>
ArgumentsTypeRequired
dataParallelCoordinatesDataRequired

Return type: Promise<void>. Call the method after element registration and await its Promise result.

getRows

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

typescript
getRows(): Promise<ParallelCoordinatesRow[]>

Return type: Promise<ParallelCoordinatesRow[]>. Call the method after element registration and await its Promise result.

getRow

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

typescript
getRow(index: number): Promise<ParallelCoordinatesRow | null>
ArgumentsTypeRequired
indexnumberRequired

Return type: Promise<ParallelCoordinatesRow | null>. Call the method after element registration and await its Promise result.

getRowById

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

typescript
getRowById(id: string): Promise<ParallelCoordinatesRow | null>
ArgumentsTypeRequired
idstringRequired

Return type: Promise<ParallelCoordinatesRow | null>. Call the method after element registration and await its Promise result.

getRowCount

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

typescript
getRowCount(): Promise<number>

Return type: Promise<number>. Call the method after element registration and await its Promise result.

getLayout

Host-local geometry as shown. Scale fields preserve ellipses under non-uniform viewport zoom.

typescript
getLayout(): Promise<ParallelCoordinatesLayoutResult>

Return type: Promise<ParallelCoordinatesLayoutResult>. Call the method after element registration and await its Promise result.

getAxes

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

typescript
getAxes(): Promise<ParallelCoordinatesAxis[]>

Return type: Promise<ParallelCoordinatesAxis[]>. Call the method after element registration and await its Promise result.

getLineModels

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

typescript
getLineModels(): Promise<ParallelCoordinatesLineModel[]>

Return type: Promise<ParallelCoordinatesLineModel[]>. Call the method after element registration and await its Promise result.

getAxisModels

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

typescript
getAxisModels(): Promise<ParallelCoordinatesAxisModel[]>

Return type: Promise<ParallelCoordinatesAxisModel[]>. Call the method after element registration and await its Promise result.

getDiagnostics

Normalization diagnostics for the effective base and stream source.

typescript
getDiagnostics(): Promise<{ invalidRecords: number; invalidIds: number; invalidValues: number; duplicates: number; invalidDimensions: number; duplicateDimensions: number; }>

Return type: Promise<{ invalidRecords: number; invalidIds: number; invalidValues: number; duplicates: number; invalidDimensions: number; duplicateDimensions: number; }>. Call the method after element registration and await its Promise result.

appendPoint

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

typescript
appendPoint(row: ParallelCoordinatesRowInput): Promise<void>
ArgumentsTypeRequired
rowParallelCoordinatesRowInputRequired

Return type: Promise<void>. Call the method after element registration and await its Promise result.

appendBatch

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

typescript
appendBatch(rows: ReadonlyArray<ParallelCoordinatesRowInput>): Promise<void>
ArgumentsTypeRequired
rowsReadonlyArray<ParallelCoordinatesRowInput>Required

Return type: Promise<void>. Call the method after element registration and await its Promise result.

shift

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

typescript
shift(count: number): Promise<void>
ArgumentsTypeRequired
countnumberRequired

Return type: Promise<void>. Call the method after element registration and await its Promise result.

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).

typescript
replace(rows: ReadonlyArray<ParallelCoordinatesRowInput>): Promise<void>
ArgumentsTypeRequired
rowsReadonlyArray<ParallelCoordinatesRowInput>Required

Return type: Promise<void>. Call the method after element registration and await its Promise result.

getStreamSource

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

typescript
getStreamSource(): Promise<ParallelCoordinatesStreamSource | undefined>

Return type: Promise<ParallelCoordinatesStreamSource | undefined>. Call the method after element registration and await its Promise result.

pauseAnimation

Pause the current animation.

typescript
pauseAnimation(): Promise<void>

Return type: Promise<void>. Call the method after element registration and await its Promise result.

resumeAnimation

Resume a paused animation.

typescript
resumeAnimation(): Promise<void>

Return type: Promise<void>. Call the method after element registration and await its Promise result.

replayAnimation

Replay the initial sweep from min → value(s). No-op when animation is off / reduced.

typescript
replayAnimation(): Promise<void>

Return type: Promise<void>. Call the method after element registration and await its Promise result.

setAnimation

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

typescript
setAnimation(options: { enabled?: boolean; duration?: number; easing?: ParallelCoordinatesEasing; type?: ParallelCoordinatesAnimationType }): Promise<void>
ArgumentsTypeRequired
options{ enabled?: boolean; duration?: number; easing?: ParallelCoordinatesEasing; type?: ParallelCoordinatesAnimationType }Required

Return type: Promise<void>. Call the method after element registration and await its Promise result.

setAxisBrushes

Replace all inclusive axis ranges. Values stay in source units and dimensions combine with AND.

typescript
setAxisBrushes(brushes: ReadonlyArray<ParallelCoordinatesAxisBrush>|null): Promise<ParallelCoordinatesBrushChangeEventDetail>
ArgumentsTypeRequired
brushesReadonlyArray<ParallelCoordinatesAxisBrush>|nullRequired

Return type: Promise<ParallelCoordinatesBrushChangeEventDetail>. Call the method after element registration and await its Promise result.

setAxisBrush

Update one axis without replacing the other ranges; null clears only that axis. Invalid requests are no-ops.

typescript
setAxisBrush(dimensionId: string, range: readonly[number,number]|null): Promise<ParallelCoordinatesBrushChangeEventDetail|null>
ArgumentsTypeRequired
dimensionIdstringRequired
rangereadonly[number,number]|nullRequired

Return type: Promise<ParallelCoordinatesBrushChangeEventDetail|null>. Call the method after element registration and await its Promise result.

clearAxisBrushes

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

typescript
clearAxisBrushes(dimensionId?: string): Promise<ParallelCoordinatesBrushChangeEventDetail>
ArgumentsTypeRequired
dimensionIdstringOptional

Return type: Promise<ParallelCoordinatesBrushChangeEventDetail>. Call the method after element registration and await its Promise result.

getAxisBrushes

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

typescript
getAxisBrushes(): Promise<ParallelCoordinatesAxisBrush[]>

Return type: Promise<ParallelCoordinatesAxisBrush[]>. Call the method after element registration and await its Promise result.

getBrushedRows

Matching source rows, including hidden styles. With no ranges, every source row matches.

typescript
getBrushedRows(): Promise<ParallelCoordinatesRow[]>

Return type: Promise<ParallelCoordinatesRow[]>. Call the method after element registration and await its Promise result.

getAxisBrushModels

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

typescript
getAxisBrushModels(): Promise<ParallelCoordinatesBrushModel[]>

Return type: Promise<ParallelCoordinatesBrushModel[]>. Call the method after element registration and await its Promise result.

hitTest

The box under a host-local CSS point (the nearest slot, within half a pitch), or null.

typescript
hitTest(cssX: number, cssY: number): Promise<ParallelCoordinatesHitDetail | null>
ArgumentsTypeRequired
cssXnumberRequired
cssYnumberRequired

Return type: Promise<ParallelCoordinatesHitDetail | null>. Call the method after element registration and await its Promise result.

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.

typescript
selectRowAt(index: number): Promise<ParallelCoordinatesHitDetail | null>
ArgumentsTypeRequired
indexnumberRequired

Return type: Promise<ParallelCoordinatesHitDetail | null>. Call the method after element registration and await its Promise result.

clearSelection

Release the selection (emits selectionChanged when there was one).

typescript
clearSelection(): Promise<void>

Return type: Promise<void>. Call the method after element registration and await its Promise result.

getSelection

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

typescript
getSelection(): Promise<ParallelCoordinatesSelection>

Return type: Promise<ParallelCoordinatesSelection>. Call the method after element registration and await its Promise result.

showTooltipAtIndex

open the tooltip on a box (the facade's showTooltipAtPoint routes here); null off the boxes or with the tooltip off.

typescript
showTooltipAtIndex(index: number): Promise<CartesianTooltipEventDetail | null>
ArgumentsTypeRequired
indexnumberRequired

Return type: Promise<CartesianTooltipEventDetail | null>. Call the method after element registration and await its Promise result.

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.

typescript
showTooltipAtPoint(index: number): Promise<CartesianTooltipEventDetail | null>
ArgumentsTypeRequired
indexnumberRequired

Return type: Promise<CartesianTooltipEventDetail | null>. Call the method after element registration and await its Promise result.

hideTooltip

Close the currently visible tooltip.

typescript
hideTooltip(): Promise<void>

Return type: Promise<void>. Call the method after element registration and await its Promise result.

zoomTo

Zoom to normalized 0..1 viewport windows: x / y as { min, max } or [min, max] (null clears that orientation).

typescript
zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>
ArgumentsTypeRequired
requestCartesianZoomRequestRequired

Return type: Promise<CartesianZoomChangeEventDetail | null>. Call the method after element registration and await its Promise result.

zoomBy

Scale the current windows by factor (< 1 zooms in) around anchorFraction (0..1, default centre).

typescript
zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>
ArgumentsTypeRequired
factornumberRequired
anchorFractionnumberOptional

Return type: Promise<CartesianZoomChangeEventDetail | null>. Call the method after element registration and await its Promise result.

panBy

Slide the zoomed windows by normalized viewport units ({ x?, y? }); a no-op at the full extent.

typescript
panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>
ArgumentsTypeRequired
delta{ x?: number; y?: number }Required

Return type: Promise<CartesianZoomChangeEventDetail | null>. Call the method after element registration and await its Promise result.

resetZoom

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

typescript
resetZoom(): Promise<CartesianZoomChangeEventDetail | null>

Return type: Promise<CartesianZoomChangeEventDetail | null>. Call the method after element registration and await its Promise result.

getZoom

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

typescript
getZoom(): Promise<CartesianZoomState | null>

Return type: Promise<CartesianZoomState | null>. Call the method after element registration and await its Promise result.

getZoomExtent

The full normalized viewport extent and axis key (null before the first layout).

typescript
getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>
ArgumentsTypeRequired
requestCartesianZoomExtentRequestOptional

Return type: Promise<CartesianZoomExtentDetail | null>. Call the method after element registration and await its Promise result.

showCrosshairAt

Quiet sync: dataX is a zero-based dimension index; dataY uses that dimension's own units.

typescript
showCrosshairAt(request: CartesianCrosshairShowRequest): Promise<boolean>
ArgumentsTypeRequired
requestCartesianCrosshairShowRequestRequired

Return type: Promise<boolean>. Call the method after element registration and await its Promise result.

hideCrosshair

hide the crosshair shown by showCrosshairAt (or the pointer's).

typescript
hideCrosshair(): Promise<void>

Return type: Promise<void>. Call the method after element registration and await its Promise result.

getDataTable

Current normalized table, including the retained stream; independent of GPU availability.

typescript
getDataTable(): Promise<ChartDataTable>

Return type: Promise<ChartDataTable>. Call the method after element registration and await its Promise result.