# Geo Map

Show geographic locations and magnitudes on a map.

Canonical: https://chart.syidax.com/docs/components/geo-map/

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

## sy-geo-map

Explore the distribution of cities, facilities, or observation sites.

Check the longitude and latitude order. Projection affects the representation of distances and areas.

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

| Input | Data description |
| --- | --- |
| `data` | An array of { longitude, latitude, value?, label? }. |
| `projection` | How geographic coordinates project onto the screen. |
| `mapRegion` | The region shown initially. |

- [Run in Components](https://chart.syidax.com/charts/geo-map) — 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-geo-map.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-geo-map",
      "props": {
        "data": [
          {
            "id": "seoul",
            "label": "Seoul",
            "longitude": 126.98,
            "latitude": 37.57,
            "value": 80
          },
          {
            "id": "tokyo",
            "label": "Tokyo",
            "longitude": 139.69,
            "latitude": 35.68,
            "value": 65
          },
          {
            "id": "taipei",
            "label": "Taipei",
            "longitude": 121.56,
            "latitude": 25.03,
            "value": 45
          },
          {
            "id": "singapore",
            "label": "Singapore",
            "longitude": 103.82,
            "latitude": 1.35,
            "value": 55
          }
        ],
        "mapRegion": "asia",
        "mapBackground": "natural-earth",
        "projection": "mercator",
        "nodeLabels": "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', 'geo-map example chart');
    return element;
  });
  container.replaceChildren(...elements);
  const chart = elements.at(-1);
  const onEvent = event => {
    console.log('nodeClick', event.detail);
  };
  chart.addEventListener('nodeClick', 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('nodeClick', onEvent);
    container.replaceChildren();
  }
</script>
```

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

## Properties

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

### data

An array of { longitude, latitude, value?, label? }.

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

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

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

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

### features

Owned geographic polygons and great-circle LineStrings, below data points.

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

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

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

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

### polygonColor

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

| Item | Value |
| --- | --- |
| JavaScript property | `polygonColor` |
| HTML attribute | `polygon-color` |
| Type | `string` |
| Default | `'#0d9488'` |

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

### polygonOpacity

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

| Item | Value |
| --- | --- |
| JavaScript property | `polygonOpacity` |
| HTML attribute | `polygon-opacity` |
| Type | `number` |
| Default | `0.7` |

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

### connectionWidth

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

| Item | Value |
| --- | --- |
| JavaScript property | `connectionWidth` |
| HTML attribute | `connection-width` |
| Type | `number` |
| Default | `2` |

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

### connectionColor

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

| Item | Value |
| --- | --- |
| JavaScript property | `connectionColor` |
| HTML attribute | `connection-color` |
| Type | `string` |
| Default | `'#7c3aed'` |

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

### connectionOpacity

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

| Item | Value |
| --- | --- |
| JavaScript property | `connectionOpacity` |
| HTML attribute | `connection-opacity` |
| Type | `number` |
| Default | `0.85` |

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

### connectionPath

Surface great-circle arcs (default), or flat-map straight routes. On globes, straight lifts the equirectangular route onto the surface.

| Item | Value |
| --- | --- |
| JavaScript property | `connectionPath` |
| HTML attribute | `connection-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-mapColorAxis"></a>

### mapColorAxis

Choropleth: feature property to a shared color ramp and numeric legend.

| Item | Value |
| --- | --- |
| JavaScript property | `mapColorAxis` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `GeoMapColorAxisInput` |
| Default | `undefined` |
| Literals in the type | `auto` |

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

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

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

### mapBubble

Geographic bubbles encode point values by area; object options are property-bound.

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

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

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

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

### mapHeat

Bounded screen-space Gaussian density below connections and points.

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

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

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

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

### mapLayers

Layer presentation masks; assign an object property. Hidden sources retain selection and pinned-card identity.

| 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-mapLegend"></a>

### mapLegend

Native buttons for point, polygon, connection and heat visibility.

| Item | Value |
| --- | --- |
| JavaScript property | `mapLegend` |
| HTML attribute | `map-legend` |
| Type | `boolean` |
| Default | `false` |

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

### mapLegendLayers

Optional ordered legend subset for geographic specializations; source layers stay intact.

| Item | Value |
| --- | --- |
| JavaScript property | `mapLegendLayers` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `ReadonlyArray<GeoMapLayer>` |
| Default | `undefined` |

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

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

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

### mapLayerNames

Pass as a JavaScript property. type: Partial<Record<GeoMapLayer,string>>.

| Item | Value |
| --- | --- |
| JavaScript property | `mapLayerNames` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `Partial<Record<GeoMapLayer,string>>` |
| Default | `undefined` |

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

- [GeoMapLayer](https://chart.syidax.com/docs/types/GeoMapLayer.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 | `400` |

<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

Padding around the coordinate frame in CSS pixels.

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

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

### projection

How geographic coordinates project onto the screen.

| Item | Value |
| --- | --- |
| JavaScript property | `projection` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `GeoMapProjection` |
| Default | `'identity'` |
| 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

The region shown initially.

| 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

Bundled public-domain land/coastline data; no runtime map download or API key.

| 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

Lock geographic dragging: flat maps wrap longitude inside a fixed frame; Albers/Orthographic rotate. Zoom is separate.

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

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

### crosshair

Geographic crosshair. Bare attribute or {} uses defaults; an object prop or JSON attribute overrides options. Omit/remove the attribute to disable.

| 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

Point-center capture distance in CSS pixels when crosshair.snap is enabled; direct marker hits also snap.

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

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

### nodeRadius

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

| Item | Value |
| --- | --- |
| JavaScript property | `nodeRadius` |
| HTML attribute | `node-radius` |
| Type | `number` |
| Default | `5` |

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

### color

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

| Item | Value |
| --- | --- |
| JavaScript property | `color` |
| HTML attribute | `color` |
| Type | `string` |
| Default | `'auto'` |

<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

Dim other point/feature glyphs around the focused, hovered or selected source identity. Heat stays unchanged.

| 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-nodeLabels"></a>

### nodeLabels

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

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

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

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

### featureLabels

Optional region and connection names, sharing point-label collision avoidance.

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

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

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

### featureLabelValue

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

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

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

### nodeLabelValue

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

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

<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-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: GeoMapHitDetail) => string.

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

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

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

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

### featureTooltipFormat

Formats owned polygon/connection metadata; point tooltipFormat remains independent.

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

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

- [GeoMapFeatureHitDetail](https://chart.syidax.com/docs/types/GeoMapFeatureHitDetail.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 | `GeoMapStreamSource` |
| Default | `undefined` |

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

- [GeoMapStreamSource](https://chart.syidax.com/docs/types/GeoMapStreamSource.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-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-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="events"></a>

## Events

<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<GeoMapRenderResult & { tier: GeoMapEngineTier }>`.

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

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

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

### nodeClick

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

Event name: `nodeClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GeoMapHitDetail>`.

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

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

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

### nodeHover

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

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

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

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

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

### featureClick

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

Event name: `featureClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GeoMapFeatureHitDetail>`.

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

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

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

### featureHover

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

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

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

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

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

### featureSelectionChange

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

Event name: `featureSelectionChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GeoMapFeatureSelectionChangeEventDetail>`.

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

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

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

### selectionChanged

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

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

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

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

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

### pointContextMenu

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

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

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

- [ChartPointContextMenuEventDetail](https://chart.syidax.com/docs/types/ChartPointContextMenuEventDetail.md) — Type definition
- [GeoMapPickDetail](https://chart.syidax.com/docs/types/GeoMapPickDetail.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-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-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="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-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="methods"></a>

## Methods

<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-redraw"></a>

### redraw

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

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

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

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

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

### recycleGpu

Release and reacquire the shared GPU surface without resetting data, pins or geographic view. Without the grant (or while frozen) nothing is recycled: 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-getConnections"></a>

### getConnections

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

```typescript
getConnections(): Promise<GeoMapConnectionView[]>
```

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

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

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

### getEngineStatus

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

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

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

- [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-getMapAvailability"></a>

### getMapAvailability

Owned current engine status. A Pro decision can be pending before asynchronous device initialization finishes.

```typescript
getMapAvailability(): Promise<GeoMapAvailabilityDetail>
```

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

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

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

### setData

Replace the bar set.

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

| Arguments | Type | Required |
| --- | --- | --- |
| `data` | `GeoMapData` | Required |

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

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

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

### setFeatures

Validate atomically; invalid input rejects and leaves the previous layer intact.

```typescript
setFeatures(features?: GeoMapFeatureCollection): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `features` | `GeoMapFeatureCollection` | Optional |

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

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

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

### getFeatures

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

```typescript
getFeatures(): Promise<GeoMapFeatureCollection>
```

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

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

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

### getMapColorAxis

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

```typescript
getMapColorAxis(): Promise<GeoMapColorAxisDetail|null>
```

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

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

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

### getFeatureSelection

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

```typescript
getFeatureSelection(): Promise<GeoMapFeatureSelection>
```

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

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

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

### selectFeatureAt

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

```typescript
selectFeatureAt(index: number): Promise<GeoMapFeatureHitDetail | null>
```

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

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

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

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

### showTooltipAtFeature

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

```typescript
showTooltipAtFeature(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-parseTopoJSON"></a>

### parseTopoJSON

Decode a Topology (object or JSON text) into owned GeoJSON; does not change chart data.

```typescript
parseTopoJSON(input: unknown, objectName?: string): Promise<GeoMapFeatureCollection>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `input` | `unknown` | Required |
| `objectName` | `string` | Optional |

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

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

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

### parseGeoJSON

Decode RFC 7946 Geometry, Feature or FeatureCollection into owned features without changing chart data.

```typescript
parseGeoJSON(input: unknown): Promise<GeoMapFeatureCollection>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `input` | `unknown` | Required |

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

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

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

### getNodes

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

```typescript
getNodes(): Promise<GeoMapPoint[]>
```

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

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

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

### getNode

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

```typescript
getNode(index: number): Promise<GeoMapPoint | null>
```

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

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

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

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

### getNodeById

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

```typescript
getNodeById(id: string): Promise<GeoMapPoint | null>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `id` | `string` | Required |

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

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

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

### getNodeCount

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

```typescript
getNodeCount(): Promise<number>
```

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

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

### getExtent

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

```typescript
getExtent(): Promise<GeoMapExtent>
```

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

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

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

### getMapDiagnostics

Current base input and active normalized stream window; not lifetime ingestion counters. Returns an owned snapshot.

```typescript
getMapDiagnostics(): Promise<GeoMapDiagnostics>
```

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

- [GeoMapDiagnostics](https://chart.syidax.com/docs/types/GeoMapDiagnostics.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<GeoMapLayoutResult>
```

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

- [GeoMapLayoutResult](https://chart.syidax.com/docs/types/GeoMapLayoutResult.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(node: GeoMapPointInput): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `node` | `GeoMapPointInput` | Required |

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

- [GeoMapPointInput](https://chart.syidax.com/docs/types/GeoMapPointInput.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(nodes: ReadonlyArray<GeoMapPointInput>): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `nodes` | `ReadonlyArray<GeoMapPointInput>` | Required |

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

- [GeoMapPointInput](https://chart.syidax.com/docs/types/GeoMapPointInput.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-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(nodes: ReadonlyArray<GeoMapPointInput>): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `nodes` | `ReadonlyArray<GeoMapPointInput>` | Required |

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

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

<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<GeoMapStreamSource | undefined>
```

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

- [GeoMapStreamSource](https://chart.syidax.com/docs/types/GeoMapStreamSource.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-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-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<GeoMapPickDetail | null>
```

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

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

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

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

### selectNodeAt

Select (pin) a node: its neighbourhood stays highlighted after the pointer leaves; a negative or unknown index releases the selection. Emits selectionChanged when it changes.

```typescript
selectNodeAt(index: number): Promise<GeoMapHitDetail | null>
```

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

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

- [GeoMapHitDetail](https://chart.syidax.com/docs/types/GeoMapHitDetail.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-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<GeoMapSelection>
```

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

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

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

### showTooltipAtIndex

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

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

| 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-showTooltipAtPoint"></a>

### showTooltipAtPoint

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

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

| 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-zoomTo"></a>

### zoomTo

Zoom to explicit windows over the unit extents: `x` / `y` as `{ min, max }` or `[min, max]` (`null` clears that orientation).

```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 unit-extent 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-getMapView"></a>

### getMapView

Owned geographic camera, effective region and viewport state.

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

Return type: `Promise<GeoMapViewDetail>`. 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-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 (0 … 1) and key of the diagram's orientations (`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-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

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

### getLabels

the placed node labels in HOST-local CSS px as shown (the plot offset added; under a zoom the labels of the nodes outside the window are left out), shown or hidden with the reason.

```typescript
getLabels(): Promise<GeoMapLabel[]>
```

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

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

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

### getMapLabels

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

```typescript
getMapLabels(): Promise<GeoMapLabelView>
```

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

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

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

### getMapHeat

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

```typescript
getMapHeat(): Promise<GeoMapHeatDetail|null>
```

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

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

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

### getMapHeatAt

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

```typescript
getMapHeatAt(cssX: number, cssY: number): Promise<GeoMapHeatPointDetail|null>
```

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

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

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

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

### getMapHeatAtCoordinate

Read the current visible density at geography without requiring a source point or marker. Returns null for invalid, projection-clipped, offscreen or rear-hemisphere coordinates and hidden heat.

```typescript
getMapHeatAtCoordinate(longitude: number, latitude: number): Promise<GeoMapHeatPointDetail|null>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `longitude` | `number` | Required |
| `latitude` | `number` | Required |

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

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

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

### getMapBubbleScale

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

```typescript
getMapBubbleScale(): Promise<GeoMapBubbleScaleDetail|null>
```

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

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

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

### showCrosshairAtData

Quiet geographic synchronization; invalid, hidden or clipped coordinates leave no guide.

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