Flow Lines

data

flows references locations IDs through from and to.

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

• FlowLinesData

  Type definition

width

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

height

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

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.

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.

padding

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

projection

Allowed values: identity, mercator, equirectangular, albers, orthographic. Default: 'equirectangular'.

• GeoMapProjection

  Type definition

mapRegion

Allowed values: world, africa, asia, europe, north-america, south-america, oceania, antarctica. Default: 'world'.

• GeoMapRegion

  Type definition

mapBackground

Allowed values: none, natural-earth. Default: 'natural-earth'.

• GeoMapBackground

  Type definition

mapFixed

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

routePath

great-circle or straight.

• GeoMapConnectionPath

  Type definition

styleOptions

Pass as a JavaScript property. type: FlowLinesStyle.

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

• FlowLinesStyle

  Type definition

locationLabels

Allowed values: auto, show, hide. Default: 'auto'.

• GeoMapLabelMode

  Type definition

flowLabels

Allowed values: auto, show, hide. Default: 'hide'.

• GeoMapLabelMode

  Type definition

labelValue

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

mapLayers

Pass as a JavaScript property. type: GeoMapLayersInput.

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

• GeoMapLayersInput

  Type definition

legend

Whether to show a legend for series or items.

activeColor

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

inactiveOtherPoints

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

inactivePointOpacity

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

chartTitle

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

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.

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

locale

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

enableMouseTracking

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

tooltip

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

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.

tooltipFormat

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

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

• FlowLinesHitDetail

  Type definition

crosshair

Pass as a JavaScript property. type: CartesianCrosshairInput.

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

• CartesianCrosshairInput

  Type definition

crosshairSnapDistance

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

zoom

Settings for zooming and the visible range.

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

• CartesianZoomInput

  Type definition

animated

Whether to animate initial display and data changes.

animationDuration

Animation duration in milliseconds.

animationEasing

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

• GeoMapEasing

  Type definition

animationType

Allowed values: initial, update. Default: undefined.

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

• GeoMapAnimationType

  Type definition

streamSource

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

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

• FlowLinesStreamSource

  Type definition

streamMax

The maximum number of streaming data points to retain.

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.

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.

• GeoMapEngineMode

  Type definition

unavailable

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

• GeoMapUnavailableBehaviour

  Type definition

showEmpty

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

pointClick

A point selection event. Read the selected data and index from CustomEvent.detail.

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

chart.addEventListener('pointClick', event => {
  console.log(event.detail); // FlowLinesHitDetail
});

• FlowLinesHitDetail

  Type definition

pointHover

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

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

chart.addEventListener('pointHover', event => {
  console.log(event.detail); // FlowLinesHitDetail|null
});

• FlowLinesHitDetail

  Type definition

selectionChanged

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

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

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

• FlowLinesSelectionChangeEventDetail

  Type definition

pointContextMenu

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

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

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

• ChartPointContextMenuEventDetail

  Type definition

• FlowLinesHitDetail

  Type definition

rendered

Emits rendering results in detail when chart drawing completes.

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

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

• FlowLinesRenderResult

  Type definition

• GeoMapEngineTier

  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}
});

dataValidationError

CustomEvent.detail type: {message:string;source:'data'|'stream'}. Event names are case-sensitive.

Event name: dataValidationError. Names are case-sensitive. Read the payload from detail on CustomEvent<{message:string;source:'data'|'stream'}>.

chart.addEventListener('dataValidationError', event => {
  console.log(event.detail); // {message:string;source:'data'|'stream'}
});

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

crosshairMove

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

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

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

• CartesianCrosshairEventDetail

  Type definition

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

mapViewChange

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

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

chart.addEventListener('mapViewChange', event => {
  console.log(event.detail); // GeoMapViewChangeEventDetail
});

• GeoMapViewChangeEventDetail

  Type definition

mapLayerChange

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

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

chart.addEventListener('mapLayerChange', event => {
  console.log(event.detail); // GeoMapLayerChangeEventDetail
});

• GeoMapLayerChangeEventDetail

  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
});

setData

Replace the bar set.

setData(data: FlowLinesData): Promise<void>

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

• FlowLinesData

  Type definition

getData

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

getData(): Promise<FlowLinesData>

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

• FlowLinesData

  Type definition

getDiagnostics

Normalization diagnostics for the effective base and stream source.

getDiagnostics(): Promise<FlowLinesDiagnostics>

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

• FlowLinesDiagnostics

  Type definition

getLayout

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

getLayout(): Promise<FlowLinesLayout>

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

• FlowLinesLayout

  Type definition

appendPoint

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

appendPoint(flow: FlowLinesRouteInput): Promise<void>

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

• FlowLinesRouteInput

  Type definition

appendBatch

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

appendBatch(flows: ReadonlyArray<FlowLinesRouteInput>): Promise<void>

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

• FlowLinesRouteInput

  Type definition

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(flows: ReadonlyArray<FlowLinesRouteInput>): Promise<void>

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

• FlowLinesRouteInput

  Type definition

shift

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

shift(count: number): Promise<void>

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.

getStreamSource(): Promise<FlowLinesStreamSource|undefined>

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

• FlowLinesStreamSource

  Type definition

clearStream

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

clearStream(): Promise<void>

Return type: Promise<void>. 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.

hitTest(cssX: number, cssY: number): Promise<FlowLinesHitDetail|null>

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

• FlowLinesHitDetail

  Type definition

selectFlowAt

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

selectFlowAt(index: number): Promise<FlowLinesHitDetail|null>

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

• FlowLinesHitDetail

  Type definition

selectLocationAt

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

selectLocationAt(index: number): Promise<FlowLinesHitDetail|null>

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

• FlowLinesHitDetail

  Type definition

selectById

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

selectById(id: FlowLinesId, kind?: 'flow'|'location'): Promise<FlowLinesHitDetail|null>

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

• FlowLinesHitDetail

  Type definition

• FlowLinesId

  Type definition

getSelection

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

getSelection(): Promise<FlowLinesSelection>

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

• FlowLinesSelection

  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.

showTooltipAtFlow

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

showTooltipAtFlow(index: number): Promise<CartesianTooltipEventDetail|null>

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

• CartesianTooltipEventDetail

  Type definition

showTooltipAtLocation

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

showTooltipAtLocation(index: number): Promise<CartesianTooltipEventDetail|null>

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.

showCrosshairAtData

Quiet source-category synchronization. Categories retain their original string or number type.

showCrosshairAtData(request: {dataX:number;dataY:number}): Promise<boolean>

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

hideCrosshair(): Promise<void>

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

zoomTo

zoom to explicit windows: x / y as { min, max } or [min, max] (null clears that orientation); xAxis / yAxis name the axis by id or slot index (default: the primary axis).

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

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>

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 data units ({ x?, y? }); a no-op at the full extent.

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

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

resetMapView

Restore the configured projection/region and clear map movement and zoom.

resetMapView(): Promise<void>

Return type: Promise<void>. 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.

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 extent (and key) of the primary — or the named — master axes (null before the first layout).

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

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

• CartesianZoomExtentDetail

  Type definition

• CartesianZoomExtentRequest

  Type definition

getMapView

Owned geographic camera, effective region and viewport state.

getMapView(): Promise<GeoMapViewDetail|null>

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

• GeoMapViewDetail

  Type definition

fitMap

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

fitMap(options?: GeoMapFitOptions): Promise<GeoMapFitDetail|null>

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

• GeoMapFitDetail

  Type definition

• GeoMapFitOptions

  Type definition

getMapLayers

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

getMapLayers(): Promise<GeoMapLayerDetail[]>

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

• GeoMapLayerDetail

  Type definition

setMapLayerVisible

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

setMapLayerVisible(layer: GeoMapLayer, visible: boolean): Promise<GeoMapLayerDetail|null>

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

• GeoMapLayerDetail

  Type definition

• GeoMapLayer

  Type definition

setAnimation

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

setAnimation(options: {enabled?:boolean;duration?:number;easing?:GeoMapEasing;type?:GeoMapAnimationType}): Promise<void>

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

• GeoMapEasing

  Type definition

• GeoMapAnimationType

  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.

recycleGpu

Without this element's grant (or while it is frozen) nothing is recycled: the refusal is reported here and no GPU work starts.

recycleGpu(): Promise<void>

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

redraw

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

redraw(): Promise<FlowLinesRenderResult>

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

• FlowLinesRenderResult

  Type definition

getEngineStatus

The inner map's status while the proxy runs; otherwise the proxy's own license outcome (engine is forwarded unchanged).

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<GeoMapEngineTier>

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

• GeoMapEngineTier

  Type definition

getUnavailableReason

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

getUnavailableReason(): Promise<string|undefined>

Return type: Promise<string|undefined>. 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