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.
| Input | Data description |
|---|---|
data | An array of { id, label?, values: { dimensionId: number } }. |
dimensions | Each axis's id, label, domain, and scale. |
- Run in Components
Change options and view framework-specific code
- Shared installation and integration
Complete implementation example
<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 } }.
| Item | Value |
|---|---|
| JavaScript property | data |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | ParallelCoordinatesData |
| Default | undefined |
undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.
- ParallelCoordinatesData
Type definition
width
Chart width in pixels. If the container width changes, update width from a ResizeObserver.
| Item | Value |
|---|---|
| JavaScript property | width |
| HTML attribute | width |
| Type | number |
| Default | 900 |
height
Chart height in pixels. Allow space for axes, titles, and the legend.
| Item | Value |
|---|---|
| JavaScript property | height |
| HTML attribute | height |
| Type | number |
| Default | 400 |
brandLogo
The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it.
| Item | Value |
|---|---|
| JavaScript property | brandLogo |
| HTML attribute | brand-logo |
| Type | string |
| Default | undefined |
undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.
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.
| Item | Value |
|---|---|
| JavaScript property | brandPosition |
| HTML attribute | brand-position |
| Type | 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' |
| Default | 'bottom-right' |
| Allowed values | top-left, top-right, bottom-left, bottom-right |
dimensions
Each axis's id, label, domain, and scale.
| Item | Value |
|---|---|
| JavaScript property | dimensions |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | ReadonlyArray<ParallelCoordinatesDimensionInput> |
| Default | undefined |
undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.
- ParallelCoordinatesDimensionInput
Type definition
lineWidth
Set as an HTML attribute or JavaScript property. type: number.
| Item | Value |
|---|---|
| JavaScript property | lineWidth |
| HTML attribute | line-width |
| Type | number |
| Default | 1.5 |
lineOpacity
Set as an HTML attribute or JavaScript property. type: number.
| Item | Value |
|---|---|
| JavaScript property | lineOpacity |
| HTML attribute | line-opacity |
| Type | number |
| Default | .65 |
lineDash
Pass as a JavaScript property. type: ReadonlyArray<number>|string.
| Item | Value |
|---|---|
| JavaScript property | lineDash |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | ReadonlyArray<number>|string |
| Default | [] |
connectNulls
Set as an HTML attribute or JavaScript property. type: boolean.
| Item | Value |
|---|---|
| JavaScript property | connectNulls |
| HTML attribute | connect-nulls |
| Type | boolean |
| Default | false |
inactiveRowOpacity
Set as an HTML attribute or JavaScript property. type: number.
| Item | Value |
|---|---|
| JavaScript property | inactiveRowOpacity |
| HTML attribute | inactive-row-opacity |
| Type | number |
| Default | .25 |
color
Set as an HTML attribute or JavaScript property. type: string.
| Item | Value |
|---|---|
| JavaScript property | color |
| HTML attribute | color |
| Type | string |
| Default | 'auto' |
activeColor
Set as an HTML attribute or JavaScript property. type: string.
| Item | Value |
|---|---|
| JavaScript property | activeColor |
| HTML attribute | active-color |
| Type | string |
| Default | '#f59e0b' |
axisLabels
Set as an HTML attribute or JavaScript property. type: boolean.
| Item | Value |
|---|---|
| JavaScript property | axisLabels |
| HTML attribute | axis-labels |
| Type | boolean |
| Default | true |
axes
Pass as a JavaScript property. type: ParallelCoordinatesAxesInput.
| Item | Value |
|---|---|
| JavaScript property | axes |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | ParallelCoordinatesAxesInput |
| Default | undefined |
undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.
- ParallelCoordinatesAxesInput
Type definition
axisBrush
Pass as a JavaScript property. type: ParallelCoordinatesBrushInput.
| Item | Value |
|---|---|
| JavaScript property | axisBrush |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | ParallelCoordinatesBrushInput |
| Default | undefined |
undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.
- ParallelCoordinatesBrushInput
Type definition
chartTitle
The title inside the chart. Explain the data's unit and meaning alongside it.
| Item | Value |
|---|---|
| JavaScript property | chartTitle |
| HTML attribute | chart-title |
| Type | string |
| Default | undefined |
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.
| Item | Value |
|---|---|
| JavaScript property | chartSubtitle |
| HTML attribute | chart-subtitle |
| Type | string |
| Default | undefined |
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.
| Item | Value |
|---|---|
| JavaScript property | enableMouseTracking |
| HTML attribute | enable-mouse-tracking |
| Type | boolean |
| Default | true |
tooltip
Tooltip settings for pointer-driven values, position, and content.
| Item | Value |
|---|---|
| JavaScript property | tooltip |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | CartesianTooltipInput |
| Default | undefined |
| Literals in the type | auto, off |
undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.
- CartesianTooltipInput
Type definition
tooltipEnabled
Set as an HTML attribute or JavaScript property. type: boolean.
| Item | Value |
|---|---|
| JavaScript property | tooltipEnabled |
| HTML attribute | tooltip-show |
| Type | boolean |
| Default | true |
tooltipFormat
Pass as a JavaScript property. type: (detail: ParallelCoordinatesHitDetail) => string.
| Item | Value |
|---|---|
| JavaScript property | tooltipFormat |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | (detail: ParallelCoordinatesHitDetail) => string |
| Default | undefined |
undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.
- ParallelCoordinatesHitDetail
Type definition
animated
Whether to animate initial display and data changes.
| Item | Value |
|---|---|
| JavaScript property | animated |
| HTML attribute | animate |
| Type | boolean |
| Default | false |
animationDuration
Animation duration in milliseconds.
| Item | Value |
|---|---|
| JavaScript property | animationDuration |
| HTML attribute | animation-duration |
| Type | number |
| Default | 600 |
animationEasing
Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'.
| Item | Value |
|---|---|
| JavaScript property | animationEasing |
| HTML attribute | animation-easing |
| Type | ParallelCoordinatesEasing |
| Default | 'ease-out' |
| Allowed values | linear, ease-out, ease-in, ease-in-out |
- ParallelCoordinatesEasing
Type definition
animationType
Allowed values: initial, update. Default: undefined.
| Item | Value |
|---|---|
| JavaScript property | animationType |
| HTML attribute | animation-type |
| Type | ParallelCoordinatesAnimationType |
| Default | undefined |
| Allowed values | initial, update |
undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.
- ParallelCoordinatesAnimationType
Type definition
streamSource
A stream source for live data. Check the contract for the specific type.
| Item | Value |
|---|---|
| JavaScript property | streamSource |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | ParallelCoordinatesStreamSource |
| Default | undefined |
undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.
- ParallelCoordinatesStreamSource
Type definition
streamMax
The maximum number of streaming data points to retain.
| Item | Value |
|---|---|
| JavaScript property | streamMax |
| HTML attribute | stream-max |
| Type | number |
| Default | undefined |
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.
| Item | Value |
|---|---|
| JavaScript property | streamWindow |
| HTML attribute | stream-window |
| Type | number |
| Default | undefined |
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.
| Item | Value |
|---|---|
| JavaScript property | zoom |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | CartesianZoomInput |
| Default | undefined |
| Literals in the type | auto, 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.
- CartesianZoomInput
Type definition
crosshair
Pass as a JavaScript property. type: CartesianCrosshairInput.
| Item | Value |
|---|---|
| JavaScript property | crosshair |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | CartesianCrosshairInput |
| Default | undefined |
undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.
- CartesianCrosshairInput
Type definition
engine
Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type.
| Item | Value |
|---|---|
| JavaScript property | engine |
| HTML attribute | engine |
| Type | ParallelCoordinatesEngineMode |
| Default | 'auto' |
| Allowed values | auto, standard, pro |
- ParallelCoordinatesEngineMode
Type definition
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 }>.
chart.addEventListener('rendered', event => {
console.log(event.detail); // ParallelCoordinatesRenderResult & { tier: ParallelCoordinatesEngineTier }
});- ParallelCoordinatesRenderResult
Type definition
- ParallelCoordinatesEngineTier
Type definition
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>.
chart.addEventListener('rowClick', event => {
console.log(event.detail); // ParallelCoordinatesHitDetail
});- ParallelCoordinatesHitDetail
Type definition
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>.
chart.addEventListener('rowHover', event => {
console.log(event.detail); // ParallelCoordinatesHitDetail | null
});- ParallelCoordinatesHitDetail
Type definition
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>.
chart.addEventListener('selectionChanged', event => {
console.log(event.detail); // ParallelCoordinatesSelectionChangeEventDetail
});- ParallelCoordinatesSelectionChangeEventDetail
Type definition
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>>.
chart.addEventListener('pointContextMenu', event => {
console.log(event.detail); // ChartPointContextMenuEventDetail<ParallelCoordinatesHitDetail>
});- ChartPointContextMenuEventDetail
Type definition
- ParallelCoordinatesHitDetail
Type definition
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 }>.
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 }>.
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>.
chart.addEventListener('tooltipShow', event => {
console.log(event.detail); // CartesianTooltipEventDetail
});- CartesianTooltipEventDetail
Type definition
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>.
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>.
chart.addEventListener('tooltipAction', event => {
console.log(event.detail); // CartesianTooltipActionEventDetail
});- CartesianTooltipActionEventDetail
Type definition
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>.
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>.
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>.
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>.
chart.addEventListener('zoomChange', event => {
console.log(event.detail); // CartesianZoomChangeEventDetail
});- CartesianZoomChangeEventDetail
Type definition
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>.
chart.addEventListener('axisBrushChange', event => {
console.log(event.detail); // ParallelCoordinatesBrushChangeEventDetail
});- ParallelCoordinatesBrushChangeEventDetail
Type definition
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>.
chart.addEventListener('axisBrushStart', event => {
console.log(event.detail); // ParallelCoordinatesBrushGestureEventDetail
});- ParallelCoordinatesBrushGestureEventDetail
Type definition
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>.
chart.addEventListener('axisBrushMove', event => {
console.log(event.detail); // ParallelCoordinatesBrushGestureEventDetail
});- ParallelCoordinatesBrushGestureEventDetail
Type definition
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>.
chart.addEventListener('axisBrushEnd', event => {
console.log(event.detail); // ParallelCoordinatesBrushGestureEventDetail
});- ParallelCoordinatesBrushGestureEventDetail
Type definition
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>.
chart.addEventListener('crosshairMove', event => {
console.log(event.detail); // ParallelCoordinatesCrosshairDetail|null
});- ParallelCoordinatesCrosshairDetail
Type definition
Methods
redraw
Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves.
redraw(): Promise<ParallelCoordinatesRenderResult>Return type: Promise<ParallelCoordinatesRenderResult>. Call the method after element registration and await its Promise result.
- ParallelCoordinatesRenderResult
Type definition
getEngineStatus
Requested engine vs what runs, and why (CHART-ADD-08); a frozen or unlicensed chart reports the license outcome.
getEngineStatus(): Promise<ChartEngineStatus>Return type: Promise<ChartEngineStatus>. Call the method after element registration and await its Promise result.
- ChartEngineStatus
Type definition
getActiveTier
An asynchronous method. Check the argument and return types below.
getActiveTier(): Promise<ParallelCoordinatesEngineTier>Return type: Promise<ParallelCoordinatesEngineTier>. Call the method after element registration and await its Promise result.
- ParallelCoordinatesEngineTier
Type definition
setData
Replace the bar set.
setData(data: ParallelCoordinatesData): Promise<void>| Arguments | Type | Required |
|---|---|---|
data | ParallelCoordinatesData | Required |
Return type: Promise<void>. Call the method after element registration and await its Promise result.
- ParallelCoordinatesData
Type definition
getRows
An asynchronous method. Check the argument and return types below.
getRows(): Promise<ParallelCoordinatesRow[]>Return type: Promise<ParallelCoordinatesRow[]>. Call the method after element registration and await its Promise result.
- ParallelCoordinatesRow
Type definition
getRow
An asynchronous method. Check the argument and return types below.
getRow(index: number): Promise<ParallelCoordinatesRow | null>| Arguments | Type | Required |
|---|---|---|
index | number | Required |
Return type: Promise<ParallelCoordinatesRow | null>. Call the method after element registration and await its Promise result.
- ParallelCoordinatesRow
Type definition
getRowById
An asynchronous method. Check the argument and return types below.
getRowById(id: string): Promise<ParallelCoordinatesRow | null>| Arguments | Type | Required |
|---|---|---|
id | string | Required |
Return type: Promise<ParallelCoordinatesRow | null>. Call the method after element registration and await its Promise result.
- ParallelCoordinatesRow
Type definition
getRowCount
An asynchronous method. Check the argument and return types below.
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.
getLayout(): Promise<ParallelCoordinatesLayoutResult>Return type: Promise<ParallelCoordinatesLayoutResult>. Call the method after element registration and await its Promise result.
- ParallelCoordinatesLayoutResult
Type definition
getAxes
An asynchronous method. Check the argument and return types below.
getAxes(): Promise<ParallelCoordinatesAxis[]>Return type: Promise<ParallelCoordinatesAxis[]>. Call the method after element registration and await its Promise result.
- ParallelCoordinatesAxis
Type definition
getLineModels
An asynchronous method. Check the argument and return types below.
getLineModels(): Promise<ParallelCoordinatesLineModel[]>Return type: Promise<ParallelCoordinatesLineModel[]>. Call the method after element registration and await its Promise result.
- ParallelCoordinatesLineModel
Type definition
getAxisModels
An asynchronous method. Check the argument and return types below.
getAxisModels(): Promise<ParallelCoordinatesAxisModel[]>Return type: Promise<ParallelCoordinatesAxisModel[]>. Call the method after element registration and await its Promise result.
- ParallelCoordinatesAxisModel
Type definition
getDiagnostics
Normalization diagnostics for the effective base and stream source.
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.
appendPoint(row: ParallelCoordinatesRowInput): Promise<void>| Arguments | Type | Required |
|---|---|---|
row | ParallelCoordinatesRowInput | Required |
Return type: Promise<void>. Call the method after element registration and await its Promise result.
- ParallelCoordinatesRowInput
Type definition
appendBatch
Append multiple values to the stream. Check the argument type and the licensing requirements for streaming.
appendBatch(rows: ReadonlyArray<ParallelCoordinatesRowInput>): Promise<void>| Arguments | Type | Required |
|---|---|---|
rows | ReadonlyArray<ParallelCoordinatesRowInput> | Required |
Return type: Promise<void>. Call the method after element registration and await its Promise result.
- ParallelCoordinatesRowInput
Type definition
shift
Drop the oldest streamed categories (the data boxes are not the stream).
shift(count: number): Promise<void>| Arguments | Type | Required |
|---|---|---|
count | number | Required |
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).
replace(rows: ReadonlyArray<ParallelCoordinatesRowInput>): Promise<void>| Arguments | Type | Required |
|---|---|---|
rows | ReadonlyArray<ParallelCoordinatesRowInput> | Required |
Return type: Promise<void>. Call the method after element registration and await its Promise result.
- ParallelCoordinatesRowInput
Type definition
getStreamSource
The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed.
getStreamSource(): Promise<ParallelCoordinatesStreamSource | undefined>Return type: Promise<ParallelCoordinatesStreamSource | undefined>. Call the method after element registration and await its Promise result.
- ParallelCoordinatesStreamSource
Type definition
pauseAnimation
Pause the current animation.
pauseAnimation(): Promise<void>Return type: Promise<void>. Call the method after element registration and await its Promise result.
resumeAnimation
Resume a paused animation.
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.
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.
setAnimation(options: { enabled?: boolean; duration?: number; easing?: ParallelCoordinatesEasing; type?: ParallelCoordinatesAnimationType }): Promise<void>| Arguments | Type | Required |
|---|---|---|
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.
- ParallelCoordinatesEasing
Type definition
- ParallelCoordinatesAnimationType
Type definition
setAxisBrushes
Replace all inclusive axis ranges. Values stay in source units and dimensions combine with AND.
setAxisBrushes(brushes: ReadonlyArray<ParallelCoordinatesAxisBrush>|null): Promise<ParallelCoordinatesBrushChangeEventDetail>| Arguments | Type | Required |
|---|---|---|
brushes | ReadonlyArray<ParallelCoordinatesAxisBrush>|null | Required |
Return type: Promise<ParallelCoordinatesBrushChangeEventDetail>. Call the method after element registration and await its Promise result.
- ParallelCoordinatesBrushChangeEventDetail
Type definition
- ParallelCoordinatesAxisBrush
Type definition
setAxisBrush
Update one axis without replacing the other ranges; null clears only that axis. Invalid requests are no-ops.
setAxisBrush(dimensionId: string, range: readonly[number,number]|null): Promise<ParallelCoordinatesBrushChangeEventDetail|null>| Arguments | Type | Required |
|---|---|---|
dimensionId | string | Required |
range | readonly[number,number]|null | Required |
Return type: Promise<ParallelCoordinatesBrushChangeEventDetail|null>. Call the method after element registration and await its Promise result.
- ParallelCoordinatesBrushChangeEventDetail
Type definition
clearAxisBrushes
An asynchronous method. Check the argument and return types below.
clearAxisBrushes(dimensionId?: string): Promise<ParallelCoordinatesBrushChangeEventDetail>| Arguments | Type | Required |
|---|---|---|
dimensionId | string | Optional |
Return type: Promise<ParallelCoordinatesBrushChangeEventDetail>. Call the method after element registration and await its Promise result.
- ParallelCoordinatesBrushChangeEventDetail
Type definition
getAxisBrushes
An asynchronous method. Check the argument and return types below.
getAxisBrushes(): Promise<ParallelCoordinatesAxisBrush[]>Return type: Promise<ParallelCoordinatesAxisBrush[]>. Call the method after element registration and await its Promise result.
- ParallelCoordinatesAxisBrush
Type definition
getBrushedRows
Matching source rows, including hidden styles. With no ranges, every source row matches.
getBrushedRows(): Promise<ParallelCoordinatesRow[]>Return type: Promise<ParallelCoordinatesRow[]>. Call the method after element registration and await its Promise result.
- ParallelCoordinatesRow
Type definition
getAxisBrushModels
An asynchronous method. Check the argument and return types below.
getAxisBrushModels(): Promise<ParallelCoordinatesBrushModel[]>Return type: Promise<ParallelCoordinatesBrushModel[]>. Call the method after element registration and await its Promise result.
- ParallelCoordinatesBrushModel
Type definition
hitTest
The box under a host-local CSS point (the nearest slot, within half a pitch), or null.
hitTest(cssX: number, cssY: number): Promise<ParallelCoordinatesHitDetail | null>| Arguments | Type | Required |
|---|---|---|
cssX | number | Required |
cssY | number | Required |
Return type: Promise<ParallelCoordinatesHitDetail | null>. Call the method after element registration and await its Promise result.
- ParallelCoordinatesHitDetail
Type definition
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.
selectRowAt(index: number): Promise<ParallelCoordinatesHitDetail | null>| Arguments | Type | Required |
|---|---|---|
index | number | Required |
Return type: Promise<ParallelCoordinatesHitDetail | null>. Call the method after element registration and await its Promise result.
- ParallelCoordinatesHitDetail
Type definition
clearSelection
Release the selection (emits selectionChanged when there was one).
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.
getSelection(): Promise<ParallelCoordinatesSelection>Return type: Promise<ParallelCoordinatesSelection>. Call the method after element registration and await its Promise result.
- ParallelCoordinatesSelection
Type definition
showTooltipAtIndex
open the tooltip on a box (the facade's showTooltipAtPoint routes here); null off the boxes or with the tooltip off.
showTooltipAtIndex(index: number): Promise<CartesianTooltipEventDetail | null>| Arguments | Type | Required |
|---|---|---|
index | number | Required |
Return type: Promise<CartesianTooltipEventDetail | null>. Call the method after element registration and await its Promise result.
- CartesianTooltipEventDetail
Type definition
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.
showTooltipAtPoint(index: number): Promise<CartesianTooltipEventDetail | null>| Arguments | Type | Required |
|---|---|---|
index | number | Required |
Return type: Promise<CartesianTooltipEventDetail | null>. Call the method after element registration and await its Promise result.
- CartesianTooltipEventDetail
Type definition
hideTooltip
Close the currently visible tooltip.
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).
zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>| Arguments | Type | Required |
|---|---|---|
request | CartesianZoomRequest | Required |
Return type: Promise<CartesianZoomChangeEventDetail | null>. Call the method after element registration and await its Promise result.
- CartesianZoomChangeEventDetail
Type definition
- CartesianZoomRequest
Type definition
zoomBy
Scale the current windows by factor (< 1 zooms in) around anchorFraction (0..1, default centre).
zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>| Arguments | Type | Required |
|---|---|---|
factor | number | Required |
anchorFraction | number | Optional |
Return type: Promise<CartesianZoomChangeEventDetail | null>. Call the method after element registration and await its Promise result.
- CartesianZoomChangeEventDetail
Type definition
panBy
Slide the zoomed windows by normalized viewport units ({ x?, y? }); a no-op at the full extent.
panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>| Arguments | Type | Required |
|---|---|---|
delta | { x?: number; y?: number } | Required |
Return type: Promise<CartesianZoomChangeEventDetail | null>. Call the method after element registration and await its Promise result.
- CartesianZoomChangeEventDetail
Type definition
resetZoom
Reset the zoomed or panned range to the original data range.
resetZoom(): Promise<CartesianZoomChangeEventDetail | null>Return type: Promise<CartesianZoomChangeEventDetail | null>. Call the method after element registration and await its Promise result.
- CartesianZoomChangeEventDetail
Type definition
getZoom
Read the current zoom range. Check the return type's nullability and the range for each axis.
getZoom(): Promise<CartesianZoomState | null>Return type: Promise<CartesianZoomState | null>. Call the method after element registration and await its Promise result.
- CartesianZoomState
Type definition
getZoomExtent
The full normalized viewport extent and axis key (null before the first layout).
getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>| Arguments | Type | Required |
|---|---|---|
request | CartesianZoomExtentRequest | Optional |
Return type: Promise<CartesianZoomExtentDetail | null>. Call the method after element registration and await its Promise result.
- CartesianZoomExtentDetail
Type definition
- CartesianZoomExtentRequest
Type definition
showCrosshairAt
Quiet sync: dataX is a zero-based dimension index; dataY uses that dimension's own units.
showCrosshairAt(request: CartesianCrosshairShowRequest): Promise<boolean>| Arguments | Type | Required |
|---|---|---|
request | CartesianCrosshairShowRequest | Required |
Return type: Promise<boolean>. Call the method after element registration and await its Promise result.
- CartesianCrosshairShowRequest
Type definition
hideCrosshair
hide the crosshair shown by showCrosshairAt (or the pointer's).
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.
getDataTable(): Promise<ChartDataTable>Return type: Promise<ChartDataTable>. Call the method after element registration and await its Promise result.
- ChartDataTable
Type definition