# Pyramid

Represent stage sizes as a pyramid.

Canonical: https://chart.syidax.com/docs/components/pyramid/

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

## sy-funnel-chart

Use to explain layered structures such as foundation, growth, and expertise.

A pyramid uses Funnel's reversed and neck settings. Provide a table for precise size comparisons.

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

| Input | Data description |
| --- | --- |
| `data` | An array of { name, value }, starting with the widest layer. |
| `reversed` | Set true to form a pyramid. |
| `neckWidth` | Set to 0. |
| `neckHeight` | Set to 0. |

- [Run in Components](https://chart.syidax.com/charts/pyramid) — 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/components/sy-funnel-chart.js';
  define0();

  const specs = [
    {
      "id": "example-chart",
      "tag": "sy-funnel-chart",
      "props": {
        "engine": "standard",
        "reversed": true,
        "neckWidth": 0,
        "neckHeight": 0,
        "data": [
          {
            "name": "Opening",
            "value": 60
          },
          {
            "name": "Growth",
            "value": 30
          },
          {
            "name": "Expert",
            "value": 10
          }
        ],
        "colors": ["#8263d9", "#239c91", "#e99954", "#d76c8f", "#4d89c4", "#95a551"],
        "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', 'pyramid example chart');
    return element;
  });
  container.replaceChildren(...elements);
  const chart = elements.at(-1);
  const onEvent = event => {
    console.log('sectionClick', event.detail);
  };
  chart.addEventListener('sectionClick', 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('sectionClick', onEvent);
    container.replaceChildren();
  }
</script>
```

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

## Properties

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

### data

An array of { name, value }, starting with the widest layer.

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

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

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

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

### reversed

Set true to form a pyramid.

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

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

### neckWidth

Set to 0.

| Item | Value |
| --- | --- |
| JavaScript property | `neckWidth` |
| HTML attribute | `neck-width` |
| Type | `number` |
| Default | `0.3` |

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

### neckHeight

Set to 0.

| Item | Value |
| --- | --- |
| JavaScript property | `neckHeight` |
| HTML attribute | `neck-height` |
| Type | `number` |
| Default | `0.25` |

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

### gap

Vertical gap between sections (px).

| Item | Value |
| --- | --- |
| JavaScript property | `gap` |
| HTML attribute | `gap` |
| Type | `number` |
| Default | `2` |

<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 | `'#2563eb'` |

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

### colors

Per-section palette. Per-section `color` always wins.

| Item | Value |
| --- | --- |
| JavaScript property | `colors` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `ReadonlyArray<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-labelPlacement"></a>

### labelPlacement

Allowed values: none, left, right, inside. Default: 'inside'.

| Item | Value |
| --- | --- |
| JavaScript property | `labelPlacement` |
| HTML attribute | `label-placement` |
| Type | `FunnelLabelPlacement` |
| Default | `'inside'` |
| Allowed values | `none`, `left`, `right`, `inside` |

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

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

### labelColor

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

| Item | Value |
| --- | --- |
| JavaScript property | `labelColor` |
| HTML attribute | `label-color` |
| Type | `string` |
| Default | `'#374151'` |

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

### insideLabelColor

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

| Item | Value |
| --- | --- |
| JavaScript property | `insideLabelColor` |
| HTML attribute | `inside-label-color` |
| Type | `string` |
| Default | `'#ffffff'` |

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

### labelFontSize

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

| Item | Value |
| --- | --- |
| JavaScript property | `labelFontSize` |
| HTML attribute | `label-font-size` |
| Type | `number` |
| Default | `12` |

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

### showValue

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

| Item | Value |
| --- | --- |
| JavaScript property | `showValue` |
| HTML attribute | `show-value` |
| Type | `boolean` |
| Default | `true` |

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

### showPercent

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

| Item | Value |
| --- | --- |
| JavaScript property | `showPercent` |
| HTML attribute | `show-percent` |
| Type | `boolean` |
| Default | `false` |

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

### valueFormat

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

| Item | Value |
| --- | --- |
| JavaScript property | `valueFormat` |
| HTML attribute | `value-format` |
| 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-leaderColor"></a>

### leaderColor

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

| Item | Value |
| --- | --- |
| JavaScript property | `leaderColor` |
| HTML attribute | `leader-color` |
| Type | `string` |
| Default | `'#cbd5e1'` |

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

### tooltipShow

Whether to display the built-in tooltip.

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

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

### tooltipFormat

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

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

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

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

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

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

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

### inactiveOtherSections

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

| Item | Value |
| --- | --- |
| JavaScript property | `inactiveOtherSections` |
| HTML attribute | `inactive-other-sections` |
| Type | `boolean` |
| Default | `false` |

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

### inactiveSectionOpacity

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

| Item | Value |
| --- | --- |
| JavaScript property | `inactiveSectionOpacity` |
| HTML attribute | `inactive-section-opacity` |
| Type | `number` |
| Default | `0.3` |

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

### activeSectionIndex

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

| Item | Value |
| --- | --- |
| JavaScript property | `activeSectionIndex` |
| HTML attribute | `active-section-index` |
| 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-legend"></a>

### legend

Whether to show a legend for series or items.

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

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

### legendPosition

Where the legend is positioned.

| Item | Value |
| --- | --- |
| JavaScript property | `legendPosition` |
| HTML attribute | `legend-position` |
| Type | `FunnelChartLegendPosition` |
| Default | `'bottom'` |
| Allowed values | `top`, `bottom`, `left`, `right` |

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

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

### legendItems

Pass as a JavaScript property. type: LegendItem[].

| Item | Value |
| --- | --- |
| JavaScript property | `legendItems` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `LegendItem[]` |
| Default | `undefined` |

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

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

<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 | `FunnelChartEasing` |
| Default | `'ease-out'` |
| Allowed values | `linear`, `ease-out`, `ease-in`, `ease-in-out` |

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

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

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

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

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

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

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

### proThreshold

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

| Item | Value |
| --- | --- |
| JavaScript property | `proThreshold` |
| HTML attribute | `pro-threshold` |
| Type | `number` |
| Default | `50_000` |

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

### unavailable

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

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

- [FunnelChartUnavailableBehaviour](https://chart.syidax.com/docs/types/FunnelChartUnavailableBehaviour.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<FunnelChartRenderResult & { tier: FunnelChartEngineTier }>`.

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

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

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

### sectionClick

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

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

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

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

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

### sectionHover

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

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

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

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

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

### pointContextMenu

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

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

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

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

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

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

- [FunnelChartTooltipShowEventDetail](https://chart.syidax.com/docs/types/FunnelChartTooltipShowEventDetail.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: FunnelChartTooltipActionEventDetail. Event names are case-sensitive.

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

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

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

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

### legendItemClick

CustomEvent.detail type: { index: number; sectionId: string; label: string; disabled: boolean }. Event names are case-sensitive.

Event name: `legendItemClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ index: number; sectionId: string; label: string; disabled: boolean }>`.

```javascript
chart.addEventListener('legendItemClick', event => {
  console.log(event.detail); // { index: number; sectionId: string; label: string; disabled: boolean }
});
```

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

### sectionToggled

CustomEvent.detail type: { index: number; sectionId: string; disabled: boolean }. Event names are case-sensitive.

Event name: `sectionToggled`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ index: number; sectionId: string; disabled: boolean }>`.

```javascript
chart.addEventListener('sectionToggled', event => {
  console.log(event.detail); // { index: number; sectionId: string; disabled: boolean }
});
```

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

### appended

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

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

```javascript
chart.addEventListener('appended', event => {
  console.log(event.detail); // { count: 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-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-redraw"></a>

### redraw

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

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

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

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

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

### getActiveTier

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

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

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

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

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

### setData

Replace the bar set.

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

| Arguments | Type | Required |
| --- | --- | --- |
| `data` | `FunnelChartData` | Required |

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

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

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

### addSection

Funnel / pyramid-only — add a section (stage). Returns its index.

```typescript
addSection(section: FunnelSectionSpec | number, opts?: { insertAt?: number }): Promise<number>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `section` | `FunnelSectionSpec \| number` | Required |
| `opts` | `{ insertAt?: number }` | Optional |

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

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

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

### removeSection

Funnel / pyramid-only — remove a section by id or index.

```typescript
removeSection(idOrIndex: string | number): Promise<boolean>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `idOrIndex` | `string \| number` | Required |

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

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

### updateSection

Funnel / pyramid-only — patch a section.

```typescript
updateSection(idOrIndex: string | number, patch: Partial<FunnelSectionSpec>): Promise<boolean>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `idOrIndex` | `string \| number` | Required |
| `patch` | `Partial<FunnelSectionSpec>` | Required |

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

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

| Arguments | Type | Required |
| --- | --- | --- |
| `section` | `FunnelSectionSpec \| number` | Required |

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

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

| Arguments | Type | Required |
| --- | --- | --- |
| `sections` | `ReadonlyArray<FunnelSectionSpec \| number>` | Required |

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

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

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(sections: ReadonlyArray<FunnelSectionSpec | number>): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `sections` | `ReadonlyArray<FunnelSectionSpec \| number>` | Required |

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

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

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

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

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

### setAnimation

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

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

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

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

- [FunnelChartEasing](https://chart.syidax.com/docs/types/FunnelChartEasing.md) — Type definition
- [FunnelChartAnimationType](https://chart.syidax.com/docs/types/FunnelChartAnimationType.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-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<FunnelChartPointerEventDetail | null>
```

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

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

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

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

### showTooltipAt

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

```typescript
showTooltipAt(idOrIndex: string | number): Promise<FunnelChartPointerEventDetail | null>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `idOrIndex` | `string \| number` | Required |

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

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

### getEngineStatus

Requested engine vs what runs, and why (CHART-ADD-08): always Standard (this type has no WebGPU renderer); read without side effects, never consults the license.

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