# Funnel

연속 단계에서 남는 수량을 보여줍니다.

Canonical: https://chart.syidax.com/ko/docs/components/funnel/

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

## sy-funnel-chart

방문에서 구매까지의 전환이나 영업 단계를 분석하세요.

서로 다른 모집단의 수치를 단계처럼 연결하지 마세요. 단계 순서를 유지하세요.

기본 차트 등급: Community. 추가 렌더러·커스텀 브랜딩 등 기능의 권한은 별도입니다.

| 입력 | 데이터 설명 |
| --- | --- |
| `data` | { name, value } 단계 배열입니다. |
| `showPercent` | 단계 값의 합 대비 비율 표시 여부입니다. |

- [Components에서 실행하기](https://chart.syidax.com/charts/funnel) — 옵션 변경과 프레임워크별 코드
- [공통 설치와 연결](https://chart.syidax.com/ko/docs/getting-started.md)

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

## 전체 적용 예제

```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",
        "data": [
          {
            "name": "방문",
            "value": 1000
          },
          {
            "name": "조회",
            "value": 680
          },
          {
            "name": "장바구니",
            "value": 320
          },
          {
            "name": "구매",
            "value": 150
          }
        ],
        "colors": ["#8263d9", "#239c91", "#e99954", "#d76c8f", "#4d89c4", "#95a551"],
        "showPercent": true,
        "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', 'funnel 예제 차트');
    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);

  // SPA에서는 화면이 해제될 때 이 함수를 호출하세요.
  function disposeChart() {
    observer.disconnect();
    chart.removeEventListener('sectionClick', onEvent);
    container.replaceChildren();
  }
</script>
```

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

## Properties

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

### data

{ name, value } 단계 배열입니다.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `data` |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | `FunnelChartData` |
| 기본값 | `[]` |

- [FunnelChartData](https://chart.syidax.com/ko/docs/types/FunnelChartData.md) — 타입 정의

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

### width

차트의 너비를 px 단위로 지정합니다. 컨테이너 너비가 변하는 앱에서는 ResizeObserver에서 width를 갱신하세요.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `width` |
| HTML attribute | `width` |
| 타입 | `number` |
| 기본값 | `420` |

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

### height

차트의 높이를 px 단위로 지정합니다. 축, 제목과 범례가 차지하는 공간을 함께 고려하세요.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `height` |
| HTML attribute | `height` |
| 타입 | `number` |
| 기본값 | `360` |

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

### brandLogo

기본값은 Syidax 심볼과 워드마크입니다. Pro의 chart.branding 권한으로 none을 지정해 제거하거나 PNG·JPEG·WebP data URL로 교체할 수 있습니다.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `brandLogo` |
| HTML attribute | `brand-logo` |
| 타입 | `string` |
| 기본값 | `undefined` |

undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.

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

### brandPosition

로고를 고정할 코너입니다. Community·Pro 모두 네 코너 중 하나를 선택할 수 있으며 화면과 이미지 내보내기에 같은 위치를 사용합니다.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `brandPosition` |
| HTML attribute | `brand-position` |
| 타입 | `'top-left' \| 'top-right' \| 'bottom-left' \| 'bottom-right'` |
| 기본값 | `'bottom-right'` |
| 허용값 | `top-left`, `top-right`, `bottom-left`, `bottom-right` |

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

### reversed

`true` makes a PYRAMID — point at the top, widening to the base.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `reversed` |
| HTML attribute | `reversed` |
| 타입 | `boolean` |
| 기본값 | `false` |

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

### neckWidth

Neck width as a fraction of the full width (funnel only).

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `neckWidth` |
| HTML attribute | `neck-width` |
| 타입 | `number` |
| 기본값 | `0.3` |

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

### neckHeight

Neck height as a fraction of the total height (funnel only; the straight bottom band).

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `neckHeight` |
| HTML attribute | `neck-height` |
| 타입 | `number` |
| 기본값 | `0.25` |

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

### gap

Vertical gap between sections (px).

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `gap` |
| HTML attribute | `gap` |
| 타입 | `number` |
| 기본값 | `2` |

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

### color

HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: string.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `color` |
| HTML attribute | `color` |
| 타입 | `string` |
| 기본값 | `'#2563eb'` |

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

### colors

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

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `colors` |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | `ReadonlyArray<string>` |
| 기본값 | `undefined` |

undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.

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

### labelPlacement

허용값: none, left, right, inside. 기본값: 'inside'.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `labelPlacement` |
| HTML attribute | `label-placement` |
| 타입 | `FunnelLabelPlacement` |
| 기본값 | `'inside'` |
| 허용값 | `none`, `left`, `right`, `inside` |

- [FunnelLabelPlacement](https://chart.syidax.com/ko/docs/types/FunnelLabelPlacement.md) — 타입 정의

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

### labelColor

HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: string.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `labelColor` |
| HTML attribute | `label-color` |
| 타입 | `string` |
| 기본값 | `'#374151'` |

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

### insideLabelColor

HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: string.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `insideLabelColor` |
| HTML attribute | `inside-label-color` |
| 타입 | `string` |
| 기본값 | `'#ffffff'` |

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

### labelFontSize

HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: number.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `labelFontSize` |
| HTML attribute | `label-font-size` |
| 타입 | `number` |
| 기본값 | `12` |

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

### showValue

HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: boolean.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `showValue` |
| HTML attribute | `show-value` |
| 타입 | `boolean` |
| 기본값 | `true` |

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

### showPercent

단계 값의 합 대비 비율 표시 여부입니다.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `showPercent` |
| HTML attribute | `show-percent` |
| 타입 | `boolean` |
| 기본값 | `false` |

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

### valueFormat

HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: string.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `valueFormat` |
| HTML attribute | `value-format` |
| 타입 | `string` |
| 기본값 | `undefined` |

undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.

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

### leaderColor

HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: string.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `leaderColor` |
| HTML attribute | `leader-color` |
| 타입 | `string` |
| 기본값 | `'#cbd5e1'` |

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

### chartTitle

차트 내부 제목입니다. 데이터의 단위와 의미를 함께 설명하세요.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `chartTitle` |
| HTML attribute | `chart-title` |
| 타입 | `string` |
| 기본값 | `undefined` |

undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.

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

### chartSubtitle

차트 내부 부제목입니다.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `chartSubtitle` |
| HTML attribute | `chart-subtitle` |
| 타입 | `string` |
| 기본값 | `undefined` |

undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.

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

### tooltipShow

내장 툴팁 표시 여부입니다.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `tooltipShow` |
| HTML attribute | `tooltip-show` |
| 타입 | `boolean` |
| 기본값 | `true` |

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

### tooltipFormat

JavaScript 프로퍼티로 전달합니다. 타입: (detail: FunnelChartPointerEventDetail) => string.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `tooltipFormat` |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | `(detail: FunnelChartPointerEventDetail) => string` |
| 기본값 | `undefined` |

undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.

- [FunnelChartPointerEventDetail](https://chart.syidax.com/ko/docs/types/FunnelChartPointerEventDetail.md) — 타입 정의

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

### tooltip

포인터에 따라 표시할 값, 위치, 내용의 툴팁 설정입니다.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `tooltip` |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | `FunnelChartTooltipInput` |
| 기본값 | `undefined` |
| 타입에 포함된 리터럴 | `auto`, `off` |

undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.

- [FunnelChartTooltipInput](https://chart.syidax.com/ko/docs/types/FunnelChartTooltipInput.md) — 타입 정의

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

### enableMouseTracking

HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: boolean.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `enableMouseTracking` |
| HTML attribute | `enable-mouse-tracking` |
| 타입 | `boolean` |
| 기본값 | `true` |

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

### inactiveOtherSections

HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: boolean.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `inactiveOtherSections` |
| HTML attribute | `inactive-other-sections` |
| 타입 | `boolean` |
| 기본값 | `false` |

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

### inactiveSectionOpacity

HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: number.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `inactiveSectionOpacity` |
| HTML attribute | `inactive-section-opacity` |
| 타입 | `number` |
| 기본값 | `0.3` |

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

### activeSectionIndex

HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: number.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `activeSectionIndex` |
| HTML attribute | `active-section-index` |
| 타입 | `number` |
| 기본값 | `undefined` |

undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.

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

### legend

시리즈 또는 항목의 범례 표시 여부입니다.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `legend` |
| HTML attribute | `legend` |
| 타입 | `boolean` |
| 기본값 | `false` |

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

### legendPosition

범례를 배치할 위치입니다.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `legendPosition` |
| HTML attribute | `legend-position` |
| 타입 | `FunnelChartLegendPosition` |
| 기본값 | `'bottom'` |
| 허용값 | `top`, `bottom`, `left`, `right` |

- [FunnelChartLegendPosition](https://chart.syidax.com/ko/docs/types/FunnelChartLegendPosition.md) — 타입 정의

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

### legendItems

JavaScript 프로퍼티로 전달합니다. 타입: LegendItem[].

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `legendItems` |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | `LegendItem[]` |
| 기본값 | `undefined` |

undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.

- [LegendItem](https://chart.syidax.com/ko/docs/types/LegendItem.md) — 타입 정의

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

### animated

초기 표시와 데이터 변경의 애니메이션 사용 여부입니다.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `animated` |
| HTML attribute | `animate` |
| 타입 | `boolean` |
| 기본값 | `false` |

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

### animationDuration

애니메이션 지속 시간(ms).

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `animationDuration` |
| HTML attribute | `animation-duration` |
| 타입 | `number` |
| 기본값 | `700` |

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

### animationEasing

허용값: linear, ease-out, ease-in, ease-in-out. 기본값: 'ease-out'.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `animationEasing` |
| HTML attribute | `animation-easing` |
| 타입 | `FunnelChartEasing` |
| 기본값 | `'ease-out'` |
| 허용값 | `linear`, `ease-out`, `ease-in`, `ease-in-out` |

- [FunnelChartEasing](https://chart.syidax.com/ko/docs/types/FunnelChartEasing.md) — 타입 정의

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

### animationType

허용값: initial, update. 기본값: undefined.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `animationType` |
| HTML attribute | `animation-type` |
| 타입 | `FunnelChartAnimationType` |
| 기본값 | `undefined` |
| 허용값 | `initial`, `update` |

undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.

- [FunnelChartAnimationType](https://chart.syidax.com/ko/docs/types/FunnelChartAnimationType.md) — 타입 정의

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

### streamSource

실시간 데이터를 전달하는 스트림 소스입니다. 해당 타입의 계약을 확인하세요.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `streamSource` |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | `FunnelChartStreamSource` |
| 기본값 | `undefined` |

undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.

- [FunnelChartStreamSource](https://chart.syidax.com/ko/docs/types/FunnelChartStreamSource.md) — 타입 정의

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

### streamWindow

화면에 유지할 스트리밍 데이터 구간입니다.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `streamWindow` |
| HTML attribute | `stream-window` |
| 타입 | `number` |
| 기본값 | `undefined` |

undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.

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

### streamMax

보관할 스트리밍 데이터의 최대 수입니다.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `streamMax` |
| HTML attribute | `stream-max` |
| 타입 | `number` |
| 기본값 | `undefined` |

undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.

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

### engine

auto·standard·pro 렌더러 선택입니다. 엔진 선택은 차트 종류의 Pro 사용 권한과 별개입니다.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `engine` |
| HTML attribute | `engine` |
| 타입 | `FunnelChartEngineMode` |
| 기본값 | `'auto'` |
| 허용값 | `auto`, `standard`, `pro` |

- [FunnelChartEngineMode](https://chart.syidax.com/ko/docs/types/FunnelChartEngineMode.md) — 타입 정의

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

### proThreshold

HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: number.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `proThreshold` |
| HTML attribute | `pro-threshold` |
| 타입 | `number` |
| 기본값 | `50_000` |

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

### unavailable

허용값: fallback, error, throw. 기본값: 'fallback'.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `unavailable` |
| HTML attribute | `unavailable` |
| 타입 | `FunnelChartUnavailableBehaviour` |
| 기본값 | `'fallback'` |
| 허용값 | `fallback`, `error`, `throw` |

- [FunnelChartUnavailableBehaviour](https://chart.syidax.com/ko/docs/types/FunnelChartUnavailableBehaviour.md) — 타입 정의

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

## Events

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

### rendered

차트 그리기가 완료되면 렌더링 결과를 detail로 전달합니다.

이벤트 이름: `rendered`. 대소문자를 구분합니다. payload는 `CustomEvent<FunnelChartRenderResult & { tier: FunnelChartEngineTier }>`의 `detail`에서 읽습니다.

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

- [FunnelChartRenderResult](https://chart.syidax.com/ko/docs/types/FunnelChartRenderResult.md) — 타입 정의
- [FunnelChartEngineTier](https://chart.syidax.com/ko/docs/types/FunnelChartEngineTier.md) — 타입 정의

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

### sectionClick

CustomEvent.detail 타입: FunnelChartPointerEventDetail. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: `sectionClick`. 대소문자를 구분합니다. payload는 `CustomEvent<FunnelChartPointerEventDetail>`의 `detail`에서 읽습니다.

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

- [FunnelChartPointerEventDetail](https://chart.syidax.com/ko/docs/types/FunnelChartPointerEventDetail.md) — 타입 정의

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

### sectionHover

CustomEvent.detail 타입: FunnelChartPointerEventDetail | null. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: `sectionHover`. 대소문자를 구분합니다. payload는 `CustomEvent<FunnelChartPointerEventDetail | null>`의 `detail`에서 읽습니다.

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

- [FunnelChartPointerEventDetail](https://chart.syidax.com/ko/docs/types/FunnelChartPointerEventDetail.md) — 타입 정의

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

### pointContextMenu

CustomEvent.detail 타입: ChartPointContextMenuEventDetail<FunnelChartPointerEventDetail>. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: `pointContextMenu`. 대소문자를 구분합니다. payload는 `CustomEvent<ChartPointContextMenuEventDetail<FunnelChartPointerEventDetail>>`의 `detail`에서 읽습니다.

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

- [ChartPointContextMenuEventDetail](https://chart.syidax.com/ko/docs/types/ChartPointContextMenuEventDetail.md) — 타입 정의
- [FunnelChartPointerEventDetail](https://chart.syidax.com/ko/docs/types/FunnelChartPointerEventDetail.md) — 타입 정의

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

### tooltipShow

내장 툴팁 표시 여부입니다.

이벤트 이름: `tooltipShow`. 대소문자를 구분합니다. payload는 `CustomEvent<FunnelChartTooltipShowEventDetail>`의 `detail`에서 읽습니다.

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

- [FunnelChartTooltipShowEventDetail](https://chart.syidax.com/ko/docs/types/FunnelChartTooltipShowEventDetail.md) — 타입 정의

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

### tooltipHide

CustomEvent.detail 타입: void. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: `tooltipHide`. 대소문자를 구분합니다. payload는 `CustomEvent<void>`의 `detail`에서 읽습니다.

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

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

### tooltipAction

CustomEvent.detail 타입: FunnelChartTooltipActionEventDetail. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: `tooltipAction`. 대소문자를 구분합니다. payload는 `CustomEvent<FunnelChartTooltipActionEventDetail>`의 `detail`에서 읽습니다.

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

- [FunnelChartTooltipActionEventDetail](https://chart.syidax.com/ko/docs/types/FunnelChartTooltipActionEventDetail.md) — 타입 정의

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

### legendItemClick

CustomEvent.detail 타입: { index: number; sectionId: string; label: string; disabled: boolean }. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: `legendItemClick`. 대소문자를 구분합니다. payload는 `CustomEvent<{ index: number; sectionId: string; label: string; disabled: boolean }>`의 `detail`에서 읽습니다.

```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 타입: { index: number; sectionId: string; disabled: boolean }. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: `sectionToggled`. 대소문자를 구분합니다. payload는 `CustomEvent<{ index: number; sectionId: string; disabled: boolean }>`의 `detail`에서 읽습니다.

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

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

### appended

CustomEvent.detail 타입: { count: number }. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: `appended`. 대소문자를 구분합니다. payload는 `CustomEvent<{ count: number }>`의 `detail`에서 읽습니다.

```javascript
chart.addEventListener('appended', event => {
  console.log(event.detail); // { count: number }
});
```

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

### windowSlid

CustomEvent.detail 타입: { dropped: number }. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: `windowSlid`. 대소문자를 구분합니다. payload는 `CustomEvent<{ dropped: number }>`의 `detail`에서 읽습니다.

```javascript
chart.addEventListener('windowSlid', event => {
  console.log(event.detail); // { dropped: number }
});
```

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

### chartAnimationStart

CustomEvent.detail 타입: void. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: `chartAnimationStart`. 대소문자를 구분합니다. payload는 `CustomEvent<void>`의 `detail`에서 읽습니다.

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

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

### chartAnimationEnd

CustomEvent.detail 타입: void. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: `chartAnimationEnd`. 대소문자를 구분합니다. payload는 `CustomEvent<void>`의 `detail`에서 읽습니다.

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

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

### chartAnimationInterrupted

CustomEvent.detail 타입: void. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: `chartAnimationInterrupted`. 대소문자를 구분합니다. payload는 `CustomEvent<void>`의 `detail`에서 읽습니다.

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

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

## Methods

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

### redraw

현재 데이터와 옵션으로 차트를 다시 그립니다. 반환되는 Promise가 완료되면 렌더링 결과를 확인할 수 있습니다.

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

반환 타입: `Promise<FunnelChartRenderResult>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [FunnelChartRenderResult](https://chart.syidax.com/ko/docs/types/FunnelChartRenderResult.md) — 타입 정의

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

### getActiveTier

비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.

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

반환 타입: `Promise<FunnelChartEngineTier>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [FunnelChartEngineTier](https://chart.syidax.com/ko/docs/types/FunnelChartEngineTier.md) — 타입 정의

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

### setData

Replace the bar set.

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

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `data` | `FunnelChartData` | 필수 |

반환 타입: `Promise<void>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [FunnelChartData](https://chart.syidax.com/ko/docs/types/FunnelChartData.md) — 타입 정의

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

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `section` | `FunnelSectionSpec \| number` | 필수 |
| `opts` | `{ insertAt?: number }` | 선택 |

반환 타입: `Promise<number>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [FunnelSectionSpec](https://chart.syidax.com/ko/docs/types/FunnelSectionSpec.md) — 타입 정의

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

### removeSection

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

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

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `idOrIndex` | `string \| number` | 필수 |

반환 타입: `Promise<boolean>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

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

### updateSection

Funnel / pyramid-only — patch a section.

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

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `idOrIndex` | `string \| number` | 필수 |
| `patch` | `Partial<FunnelSectionSpec>` | 필수 |

반환 타입: `Promise<boolean>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [FunnelSectionSpec](https://chart.syidax.com/ko/docs/types/FunnelSectionSpec.md) — 타입 정의

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

### appendPoint

스트림에 값 하나를 추가합니다. 메서드 인수 타입과 스트리밍 기능의 라이선스 조건을 확인하세요.

```typescript
appendPoint(section: FunnelSectionSpec | number): Promise<void>
```

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `section` | `FunnelSectionSpec \| number` | 필수 |

반환 타입: `Promise<void>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [FunnelSectionSpec](https://chart.syidax.com/ko/docs/types/FunnelSectionSpec.md) — 타입 정의

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

### appendBatch

스트림에 여러 값을 한 번에 추가합니다. 메서드 인수 타입과 스트리밍 기능의 라이선스 조건을 확인하세요.

```typescript
appendBatch(sections: ReadonlyArray<FunnelSectionSpec | number>): Promise<void>
```

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `sections` | `ReadonlyArray<FunnelSectionSpec \| number>` | 필수 |

반환 타입: `Promise<void>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [FunnelSectionSpec](https://chart.syidax.com/ko/docs/types/FunnelSectionSpec.md) — 타입 정의

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

### shift

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

```typescript
shift(count?: number): Promise<void>
```

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `count` | `number` | 선택 |

반환 타입: `Promise<void>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

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

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `sections` | `ReadonlyArray<FunnelSectionSpec \| number>` | 필수 |

반환 타입: `Promise<void>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [FunnelSectionSpec](https://chart.syidax.com/ko/docs/types/FunnelSectionSpec.md) — 타입 정의

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

반환 타입: `Promise<FunnelChartStreamSource | undefined>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [FunnelChartStreamSource](https://chart.syidax.com/ko/docs/types/FunnelChartStreamSource.md) — 타입 정의

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

### setAnimation

비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.

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

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `options` | `{ duration?: number; easing?: FunnelChartEasing; enabled?: boolean; type?: FunnelChartAnimationType }` | 필수 |

반환 타입: `Promise<void>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [FunnelChartEasing](https://chart.syidax.com/ko/docs/types/FunnelChartEasing.md) — 타입 정의
- [FunnelChartAnimationType](https://chart.syidax.com/ko/docs/types/FunnelChartAnimationType.md) — 타입 정의

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

### pauseAnimation

진행 중인 애니메이션을 일시 정지합니다.

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

반환 타입: `Promise<void>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

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

### resumeAnimation

일시 정지한 애니메이션을 다시 진행합니다.

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

반환 타입: `Promise<void>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

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

반환 타입: `Promise<void>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

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

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `cssX` | `number` | 필수 |
| `cssY` | `number` | 필수 |

반환 타입: `Promise<FunnelChartPointerEventDetail | null>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [FunnelChartPointerEventDetail](https://chart.syidax.com/ko/docs/types/FunnelChartPointerEventDetail.md) — 타입 정의

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

### showTooltipAt

비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.

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

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `idOrIndex` | `string \| number` | 필수 |

반환 타입: `Promise<FunnelChartPointerEventDetail | null>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [FunnelChartPointerEventDetail](https://chart.syidax.com/ko/docs/types/FunnelChartPointerEventDetail.md) — 타입 정의

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

### hideTooltip

현재 표시 중인 툴팁을 닫습니다.

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

반환 타입: `Promise<void>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

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

반환 타입: `Promise<ChartEngineStatus>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [ChartEngineStatus](https://chart.syidax.com/ko/docs/types/ChartEngineStatus.md) — 타입 정의