# Flow Lines

Connect movement between locations on a map.

Canonical: https://chart.syidax.com/docs/components/flow-lines/

<a id="overview"></a>

## sy-flow-lines

Explore logistics, routes, and movement volumes between regions.

Great-circle routes differ from straight lines on a projected map. Distinguish connection volume from the actual travel path.

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

| Input | Data description |
| --- | --- |
| `data` | flows references locations IDs through from and to. |
| `routePath` | great-circle or straight. |

- [Run in Components](https://chart.syidax.com/charts/flow-lines) — Change options and view framework-specific code
- [Shared installation and integration](https://chart.syidax.com/docs/getting-started.md)

<a id="example"></a>

## 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-flow-lines.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-flow-lines",
      "props": {
        "data": {
          "locations": [
            {
              "id": "seoul",
              "label": "Seoul",
              "longitude": 126.98,
              "latitude": 37.57
            },
            {
              "id": "tokyo",
              "label": "Tokyo",
              "longitude": 139.69,
              "latitude": 35.68
            },
            {
              "id": "taipei",
              "label": "Taipei",
              "longitude": 121.56,
              "latitude": 25.03
            },
            {
              "id": "singapore",
              "label": "Singapore",
              "longitude": 103.82,
              "latitude": 1.35
            }
          ],
          "flows": [
            {
              "id": "s-t",
              "from": "seoul",
              "to": "tokyo",
              "value": 80
            },
            {
              "id": "s-p",
              "from": "seoul",
              "to": "taipei",
              "value": 45
            },
            {
              "id": "p-s",
              "from": "taipei",
              "to": "singapore",
              "value": 30
            }
          ]
        },
        "mapRegion": "asia",
        "mapBackground": "natural-earth",
        "routePath": "great-circle",
        "locationLabels": "show",
        "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', 'flow-lines example chart');
    return element;
  });
  container.replaceChildren(...elements);
  const chart = elements.at(-1);
  const onEvent = event => {
    console.log('pointClick', event.detail);
  };
  chart.addEventListener('pointClick', 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('pointClick', onEvent);
    container.replaceChildren();
  }
</script>
```

<a id="props"></a>

## Properties

<a id="property-data"></a>

### data

flows references locations IDs through from and to.

| Item | Value |
| --- | --- |
| JavaScript property | `data` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `FlowLinesData` |
| Default | `undefined` |

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

- [FlowLinesData](https://chart.syidax.com/docs/types/FlowLinesData.md) — Type definition

<a id="property-width"></a>

### 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` |

<a id="property-height"></a>

### height

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

| Item | Value |
| --- | --- |
| JavaScript property | `height` |
| HTML attribute | `height` |
| Type | `number` |
| Default | `460` |

<a id="property-brandLogo"></a>

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

<a id="property-brandPosition"></a>

### 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` |

<a id="property-padding"></a>

### padding

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

| Item | Value |
| --- | --- |
| JavaScript property | `padding` |
| HTML attribute | `padding` |
| Type | `number` |
| Default | `16` |

<a id="property-projection"></a>

### projection

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

| Item | Value |
| --- | --- |
| JavaScript property | `projection` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `GeoMapProjection` |
| Default | `'equirectangular'` |
| Literals in the type | `identity`, `mercator`, `equirectangular`, `albers`, `orthographic` |

- [GeoMapProjection](https://chart.syidax.com/docs/types/GeoMapProjection.md) — Type definition

<a id="property-mapRegion"></a>

### mapRegion

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

| Item | Value |
| --- | --- |
| JavaScript property | `mapRegion` |
| HTML attribute | `map-region` |
| Type | `GeoMapRegion` |
| Default | `'world'` |
| Allowed values | `world`, `africa`, `asia`, `europe`, `north-america`, `south-america`, `oceania`, `antarctica` |

- [GeoMapRegion](https://chart.syidax.com/docs/types/GeoMapRegion.md) — Type definition

<a id="property-mapBackground"></a>

### mapBackground

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

| Item | Value |
| --- | --- |
| JavaScript property | `mapBackground` |
| HTML attribute | `map-background` |
| Type | `GeoMapBackground` |
| Default | `'natural-earth'` |
| Allowed values | `none`, `natural-earth` |

- [GeoMapBackground](https://chart.syidax.com/docs/types/GeoMapBackground.md) — Type definition

<a id="property-mapFixed"></a>

### mapFixed

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

| Item | Value |
| --- | --- |
| JavaScript property | `mapFixed` |
| HTML attribute | `map-fixed` |
| Type | `boolean` |
| Default | `false` |

<a id="property-routePath"></a>

### routePath

great-circle or straight.

| Item | Value |
| --- | --- |
| JavaScript property | `routePath` |
| HTML attribute | `route-path` |
| Type | `GeoMapConnectionPath` |
| Default | `'great-circle'` |
| Allowed values | `great-circle`, `straight` |

- [GeoMapConnectionPath](https://chart.syidax.com/docs/types/GeoMapConnectionPath.md) — Type definition

<a id="property-styleOptions"></a>

### styleOptions

Pass as a JavaScript property. type: FlowLinesStyle.

| Item | Value |
| --- | --- |
| JavaScript property | `styleOptions` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `FlowLinesStyle` |
| Default | `undefined` |

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

- [FlowLinesStyle](https://chart.syidax.com/docs/types/FlowLinesStyle.md) — Type definition

<a id="property-locationLabels"></a>

### locationLabels

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

| Item | Value |
| --- | --- |
| JavaScript property | `locationLabels` |
| HTML attribute | `location-labels` |
| Type | `GeoMapLabelMode` |
| Default | `'auto'` |
| Allowed values | `auto`, `show`, `hide` |

- [GeoMapLabelMode](https://chart.syidax.com/docs/types/GeoMapLabelMode.md) — Type definition

<a id="property-flowLabels"></a>

### flowLabels

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

| Item | Value |
| --- | --- |
| JavaScript property | `flowLabels` |
| HTML attribute | `flow-labels` |
| Type | `GeoMapLabelMode` |
| Default | `'hide'` |
| Allowed values | `auto`, `show`, `hide` |

- [GeoMapLabelMode](https://chart.syidax.com/docs/types/GeoMapLabelMode.md) — Type definition

<a id="property-labelValue"></a>

### labelValue

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

| Item | Value |
| --- | --- |
| JavaScript property | `labelValue` |
| HTML attribute | `label-value` |
| Type | `boolean` |
| Default | `false` |

<a id="property-mapLayers"></a>

### mapLayers

Pass as a JavaScript property. type: GeoMapLayersInput.

| Item | Value |
| --- | --- |
| JavaScript property | `mapLayers` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `GeoMapLayersInput` |
| Default | `undefined` |

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

- [GeoMapLayersInput](https://chart.syidax.com/docs/types/GeoMapLayersInput.md) — Type definition

<a id="property-legend"></a>

### legend

Whether to show a legend for series or items.

| Item | Value |
| --- | --- |
| JavaScript property | `legend` |
| HTML attribute | `legend` |
| Type | `boolean` |
| Default | `true` |

<a id="property-activeColor"></a>

### activeColor

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

| Item | Value |
| --- | --- |
| JavaScript property | `activeColor` |
| HTML attribute | `active-color` |
| Type | `string` |
| Default | `'#f59e0b'` |

<a id="property-inactiveOtherPoints"></a>

### inactiveOtherPoints

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

| Item | Value |
| --- | --- |
| JavaScript property | `inactiveOtherPoints` |
| HTML attribute | `inactive-other-points` |
| Type | `boolean` |
| Default | `false` |

<a id="property-inactivePointOpacity"></a>

### inactivePointOpacity

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

| Item | Value |
| --- | --- |
| JavaScript property | `inactivePointOpacity` |
| HTML attribute | `inactive-point-opacity` |
| Type | `number` |
| Default | `.2` |

<a id="property-chartTitle"></a>

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

<a id="property-chartSubtitle"></a>

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

<a id="property-locale"></a>

### locale

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

| Item | Value |
| --- | --- |
| JavaScript property | `locale` |
| HTML attribute | `locale` |
| Type | `string` |
| Default | `'en-US'` |

<a id="property-enableMouseTracking"></a>

### 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` |

<a id="property-tooltip"></a>

### 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](https://chart.syidax.com/docs/types/CartesianTooltipInput.md) — Type definition

<a id="property-tooltipEnabled"></a>

### tooltipEnabled

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

| Item | Value |
| --- | --- |
| JavaScript property | `tooltipEnabled` |
| HTML attribute | `tooltip-show` |
| Type | `boolean` |
| Default | `true` |

<a id="property-tooltipFormat"></a>

### tooltipFormat

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

| Item | Value |
| --- | --- |
| JavaScript property | `tooltipFormat` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `(detail:FlowLinesHitDetail)=>string` |
| Default | `undefined` |

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

- [FlowLinesHitDetail](https://chart.syidax.com/docs/types/FlowLinesHitDetail.md) — Type definition

<a id="property-crosshair"></a>

### 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](https://chart.syidax.com/docs/types/CartesianCrosshairInput.md) — Type definition

<a id="property-crosshairSnapDistance"></a>

### crosshairSnapDistance

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

| Item | Value |
| --- | --- |
| JavaScript property | `crosshairSnapDistance` |
| HTML attribute | `crosshair-snap-distance` |
| Type | `number` |
| Default | `12` |

<a id="property-zoom"></a>

### 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](https://chart.syidax.com/docs/types/CartesianZoomInput.md) — Type definition

<a id="property-animated"></a>

### animated

Whether to animate initial display and data changes.

| Item | Value |
| --- | --- |
| JavaScript property | `animated` |
| HTML attribute | `animate` |
| Type | `boolean` |
| Default | `false` |

<a id="property-animationDuration"></a>

### animationDuration

Animation duration in milliseconds.

| Item | Value |
| --- | --- |
| JavaScript property | `animationDuration` |
| HTML attribute | `animation-duration` |
| Type | `number` |
| Default | `600` |

<a id="property-animationEasing"></a>

### animationEasing

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

| Item | Value |
| --- | --- |
| JavaScript property | `animationEasing` |
| HTML attribute | `animation-easing` |
| Type | `GeoMapEasing` |
| Default | `'ease-out'` |
| Allowed values | `linear`, `ease-out`, `ease-in`, `ease-in-out` |

- [GeoMapEasing](https://chart.syidax.com/docs/types/GeoMapEasing.md) — Type definition

<a id="property-animationType"></a>

### animationType

Allowed values: initial, update. Default: undefined.

| Item | Value |
| --- | --- |
| JavaScript property | `animationType` |
| HTML attribute | `animation-type` |
| Type | `GeoMapAnimationType` |
| 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.

- [GeoMapAnimationType](https://chart.syidax.com/docs/types/GeoMapAnimationType.md) — Type definition

<a id="property-streamSource"></a>

### 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 | `FlowLinesStreamSource` |
| Default | `undefined` |

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

- [FlowLinesStreamSource](https://chart.syidax.com/docs/types/FlowLinesStreamSource.md) — Type definition

<a id="property-streamMax"></a>

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

<a id="property-streamWindow"></a>

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

<a id="property-engine"></a>

### 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 | `GeoMapEngineMode` |
| Default | `'auto'` |
| Allowed values | `auto`, `standard`, `pro` |

- [GeoMapEngineMode](https://chart.syidax.com/docs/types/GeoMapEngineMode.md) — Type definition

<a id="property-unavailable"></a>

### unavailable

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

| Item | Value |
| --- | --- |
| JavaScript property | `unavailable` |
| HTML attribute | `unavailable` |
| Type | `GeoMapUnavailableBehaviour` |
| Default | `'fallback'` |
| Allowed values | `fallback`, `error` |

- [GeoMapUnavailableBehaviour](https://chart.syidax.com/docs/types/GeoMapUnavailableBehaviour.md) — Type definition

<a id="property-showEmpty"></a>

### showEmpty

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

| Item | Value |
| --- | --- |
| JavaScript property | `showEmpty` |
| HTML attribute | `show-empty` |
| Type | `boolean` |
| Default | `true` |

<a id="events"></a>

## Events

<a id="event-pointClick"></a>

### 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>`.

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

- [FlowLinesHitDetail](https://chart.syidax.com/docs/types/FlowLinesHitDetail.md) — Type definition

<a id="event-pointHover"></a>

### 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>`.

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

- [FlowLinesHitDetail](https://chart.syidax.com/docs/types/FlowLinesHitDetail.md) — Type definition

<a id="event-selectionChanged"></a>

### 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>`.

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

- [FlowLinesSelectionChangeEventDetail](https://chart.syidax.com/docs/types/FlowLinesSelectionChangeEventDetail.md) — Type definition

<a id="event-pointContextMenu"></a>

### 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>>`.

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

- [ChartPointContextMenuEventDetail](https://chart.syidax.com/docs/types/ChartPointContextMenuEventDetail.md) — Type definition
- [FlowLinesHitDetail](https://chart.syidax.com/docs/types/FlowLinesHitDetail.md) — Type definition

<a id="event-rendered"></a>

### 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}>`.

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

- [FlowLinesRenderResult](https://chart.syidax.com/docs/types/FlowLinesRenderResult.md) — Type definition
- [GeoMapEngineTier](https://chart.syidax.com/docs/types/GeoMapEngineTier.md) — Type definition

<a id="event-appended"></a>

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

<a id="event-windowSlid"></a>

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

<a id="event-dataValidationError"></a>

### 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'}>`.

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

<a id="event-tooltipShow"></a>

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

- [CartesianTooltipEventDetail](https://chart.syidax.com/docs/types/CartesianTooltipEventDetail.md) — Type definition

<a id="event-tooltipHide"></a>

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

<a id="event-tooltipAction"></a>

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

- [CartesianTooltipActionEventDetail](https://chart.syidax.com/docs/types/CartesianTooltipActionEventDetail.md) — Type definition

<a id="event-crosshairMove"></a>

### 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>`.

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

- [CartesianCrosshairEventDetail](https://chart.syidax.com/docs/types/CartesianCrosshairEventDetail.md) — Type definition

<a id="event-zoomChange"></a>

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

- [CartesianZoomChangeEventDetail](https://chart.syidax.com/docs/types/CartesianZoomChangeEventDetail.md) — Type definition

<a id="event-mapViewChange"></a>

### 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>`.

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

- [GeoMapViewChangeEventDetail](https://chart.syidax.com/docs/types/GeoMapViewChangeEventDetail.md) — Type definition

<a id="event-mapLayerChange"></a>

### 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>`.

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

- [GeoMapLayerChangeEventDetail](https://chart.syidax.com/docs/types/GeoMapLayerChangeEventDetail.md) — Type definition

<a id="event-chartAnimationStart"></a>

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

<a id="event-chartAnimationEnd"></a>

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

<a id="event-chartAnimationInterrupted"></a>

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

<a id="methods"></a>

## Methods

<a id="method-setData"></a>

### setData

Replace the bar set.

```typescript
setData(data: FlowLinesData): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `data` | `FlowLinesData` | Required |

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

- [FlowLinesData](https://chart.syidax.com/docs/types/FlowLinesData.md) — Type definition

<a id="method-getData"></a>

### getData

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

```typescript
getData(): Promise<FlowLinesData>
```

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

- [FlowLinesData](https://chart.syidax.com/docs/types/FlowLinesData.md) — Type definition

<a id="method-getDiagnostics"></a>

### getDiagnostics

Normalization diagnostics for the effective base and stream source.

```typescript
getDiagnostics(): Promise<FlowLinesDiagnostics>
```

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

- [FlowLinesDiagnostics](https://chart.syidax.com/docs/types/FlowLinesDiagnostics.md) — Type definition

<a id="method-getLayout"></a>

### getLayout

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

```typescript
getLayout(): Promise<FlowLinesLayout>
```

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

- [FlowLinesLayout](https://chart.syidax.com/docs/types/FlowLinesLayout.md) — Type definition

<a id="method-appendPoint"></a>

### appendPoint

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

```typescript
appendPoint(flow: FlowLinesRouteInput): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `flow` | `FlowLinesRouteInput` | Required |

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

- [FlowLinesRouteInput](https://chart.syidax.com/docs/types/FlowLinesRouteInput.md) — Type definition

<a id="method-appendBatch"></a>

### appendBatch

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

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

| Arguments | Type | Required |
| --- | --- | --- |
| `flows` | `ReadonlyArray<FlowLinesRouteInput>` | Required |

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

- [FlowLinesRouteInput](https://chart.syidax.com/docs/types/FlowLinesRouteInput.md) — Type definition

<a id="method-replace"></a>

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

| Arguments | Type | Required |
| --- | --- | --- |
| `flows` | `ReadonlyArray<FlowLinesRouteInput>` | Required |

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

- [FlowLinesRouteInput](https://chart.syidax.com/docs/types/FlowLinesRouteInput.md) — Type definition

<a id="method-shift"></a>

### shift

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

```typescript
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.

<a id="method-getStreamSource"></a>

### getStreamSource

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

```typescript
getStreamSource(): Promise<FlowLinesStreamSource|undefined>
```

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

- [FlowLinesStreamSource](https://chart.syidax.com/docs/types/FlowLinesStreamSource.md) — Type definition

<a id="method-clearStream"></a>

### clearStream

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

```typescript
clearStream(): Promise<void>
```

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

<a id="method-hitTest"></a>

### 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<FlowLinesHitDetail|null>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `cssX` | `number` | Required |
| `cssY` | `number` | Required |

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

- [FlowLinesHitDetail](https://chart.syidax.com/docs/types/FlowLinesHitDetail.md) — Type definition

<a id="method-selectFlowAt"></a>

### selectFlowAt

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

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

| Arguments | Type | Required |
| --- | --- | --- |
| `index` | `number` | Required |

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

- [FlowLinesHitDetail](https://chart.syidax.com/docs/types/FlowLinesHitDetail.md) — Type definition

<a id="method-selectLocationAt"></a>

### selectLocationAt

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

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

| Arguments | Type | Required |
| --- | --- | --- |
| `index` | `number` | Required |

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

- [FlowLinesHitDetail](https://chart.syidax.com/docs/types/FlowLinesHitDetail.md) — Type definition

<a id="method-selectById"></a>

### selectById

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

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

| Arguments | Type | Required |
| --- | --- | --- |
| `id` | `FlowLinesId` | Required |
| `kind` | `'flow'\|'location'` | Optional |

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

- [FlowLinesHitDetail](https://chart.syidax.com/docs/types/FlowLinesHitDetail.md) — Type definition
- [FlowLinesId](https://chart.syidax.com/docs/types/FlowLinesId.md) — Type definition

<a id="method-getSelection"></a>

### 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<FlowLinesSelection>
```

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

- [FlowLinesSelection](https://chart.syidax.com/docs/types/FlowLinesSelection.md) — Type definition

<a id="method-clearSelection"></a>

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

<a id="method-showTooltipAtFlow"></a>

### showTooltipAtFlow

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

```typescript
showTooltipAtFlow(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](https://chart.syidax.com/docs/types/CartesianTooltipEventDetail.md) — Type definition

<a id="method-showTooltipAtLocation"></a>

### showTooltipAtLocation

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

```typescript
showTooltipAtLocation(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](https://chart.syidax.com/docs/types/CartesianTooltipEventDetail.md) — Type definition

<a id="method-hideTooltip"></a>

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

<a id="method-showCrosshairAtData"></a>

### showCrosshairAtData

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

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

| Arguments | Type | Required |
| --- | --- | --- |
| `request` | `{dataX:number;dataY:number}` | Required |

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

<a id="method-hideCrosshair"></a>

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

<a id="method-zoomTo"></a>

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

```typescript
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](https://chart.syidax.com/docs/types/CartesianZoomChangeEventDetail.md) — Type definition
- [CartesianZoomRequest](https://chart.syidax.com/docs/types/CartesianZoomRequest.md) — Type definition

<a id="method-zoomBy"></a>

### 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>
```

| 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](https://chart.syidax.com/docs/types/CartesianZoomChangeEventDetail.md) — Type definition

<a id="method-panBy"></a>

### panBy

slide the zoomed windows by data units (`{ x?, y? }`); a no-op at the full extent.

```typescript
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](https://chart.syidax.com/docs/types/CartesianZoomChangeEventDetail.md) — Type definition

<a id="method-resetZoom"></a>

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

- [CartesianZoomChangeEventDetail](https://chart.syidax.com/docs/types/CartesianZoomChangeEventDetail.md) — Type definition

<a id="method-resetMapView"></a>

### resetMapView

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

```typescript
resetMapView(): Promise<void>
```

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

<a id="method-getZoom"></a>

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

- [CartesianZoomState](https://chart.syidax.com/docs/types/CartesianZoomState.md) — Type definition

<a id="method-getZoomExtent"></a>

### getZoomExtent

the full extent (and key) of the primary — or the named — master axes (`null` before the first layout).

```typescript
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](https://chart.syidax.com/docs/types/CartesianZoomExtentDetail.md) — Type definition
- [CartesianZoomExtentRequest](https://chart.syidax.com/docs/types/CartesianZoomExtentRequest.md) — Type definition

<a id="method-getMapView"></a>

### getMapView

Owned geographic camera, effective region and viewport state.

```typescript
getMapView(): Promise<GeoMapViewDetail|null>
```

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

- [GeoMapViewDetail](https://chart.syidax.com/docs/types/GeoMapViewDetail.md) — Type definition

<a id="method-fitMap"></a>

### fitMap

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

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

| Arguments | Type | Required |
| --- | --- | --- |
| `options` | `GeoMapFitOptions` | Optional |

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

- [GeoMapFitDetail](https://chart.syidax.com/docs/types/GeoMapFitDetail.md) — Type definition
- [GeoMapFitOptions](https://chart.syidax.com/docs/types/GeoMapFitOptions.md) — Type definition

<a id="method-getMapLayers"></a>

### getMapLayers

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

```typescript
getMapLayers(): Promise<GeoMapLayerDetail[]>
```

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

- [GeoMapLayerDetail](https://chart.syidax.com/docs/types/GeoMapLayerDetail.md) — Type definition

<a id="method-setMapLayerVisible"></a>

### setMapLayerVisible

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

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

| Arguments | Type | Required |
| --- | --- | --- |
| `layer` | `GeoMapLayer` | Required |
| `visible` | `boolean` | Required |

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

- [GeoMapLayerDetail](https://chart.syidax.com/docs/types/GeoMapLayerDetail.md) — Type definition
- [GeoMapLayer](https://chart.syidax.com/docs/types/GeoMapLayer.md) — Type definition

<a id="method-setAnimation"></a>

### setAnimation

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

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

| Arguments | Type | Required |
| --- | --- | --- |
| `options` | `{enabled?:boolean;duration?:number;easing?:GeoMapEasing;type?:GeoMapAnimationType}` | Required |

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

- [GeoMapEasing](https://chart.syidax.com/docs/types/GeoMapEasing.md) — Type definition
- [GeoMapAnimationType](https://chart.syidax.com/docs/types/GeoMapAnimationType.md) — Type definition

<a id="method-pauseAnimation"></a>

### pauseAnimation

Pause the current animation.

```typescript
pauseAnimation(): Promise<void>
```

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

<a id="method-resumeAnimation"></a>

### resumeAnimation

Resume a paused animation.

```typescript
resumeAnimation(): Promise<void>
```

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

<a id="method-replayAnimation"></a>

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

<a id="method-recycleGpu"></a>

### recycleGpu

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

```typescript
recycleGpu(): Promise<void>
```

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

<a id="method-redraw"></a>

### redraw

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

```typescript
redraw(): Promise<FlowLinesRenderResult>
```

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

- [FlowLinesRenderResult](https://chart.syidax.com/docs/types/FlowLinesRenderResult.md) — Type definition

<a id="method-getEngineStatus"></a>

### getEngineStatus

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

```typescript
getEngineStatus(): Promise<ChartEngineStatus>
```

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

- [ChartEngineStatus](https://chart.syidax.com/docs/types/ChartEngineStatus.md) — Type definition

<a id="method-getActiveTier"></a>

### getActiveTier

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

```typescript
getActiveTier(): Promise<GeoMapEngineTier>
```

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

- [GeoMapEngineTier](https://chart.syidax.com/docs/types/GeoMapEngineTier.md) — Type definition

<a id="method-getUnavailableReason"></a>

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

<a id="method-getDataTable"></a>

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

- [ChartDataTable](https://chart.syidax.com/docs/types/ChartDataTable.md) — Type definition