Pyramid

data

넓은 층부터 입력한 { name, value } 배열입니다.

• FunnelChartData

  타입 정의

width

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

height

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

brandLogo

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

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

brandPosition

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

reversed

true로 피라미드 방향을 만듭니다.

neckWidth

0으로 설정합니다.

neckHeight

0으로 설정합니다.

gap

Vertical gap between sections (px).

color

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

colors

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

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

labelPlacement

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

• FunnelLabelPlacement

  타입 정의

labelColor

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

insideLabelColor

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

labelFontSize

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

showValue

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

showPercent

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

valueFormat

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

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

leaderColor

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

chartTitle

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

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

chartSubtitle

차트 내부 부제목입니다.

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

tooltipShow

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

tooltipFormat

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

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

• FunnelChartPointerEventDetail

  타입 정의

tooltip

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

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

• FunnelChartTooltipInput

  타입 정의

enableMouseTracking

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

inactiveOtherSections

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

inactiveSectionOpacity

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

activeSectionIndex

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

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

legend

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

legendPosition

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

• FunnelChartLegendPosition

  타입 정의

legendItems

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

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

• LegendItem

  타입 정의

animated

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

animationDuration

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

animationEasing

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

• FunnelChartEasing

  타입 정의

animationType

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

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

• FunnelChartAnimationType

  타입 정의

streamSource

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

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

• FunnelChartStreamSource

  타입 정의

streamWindow

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

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

streamMax

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

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

engine

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

• FunnelChartEngineMode

  타입 정의

proThreshold

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

unavailable

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

• FunnelChartUnavailableBehaviour

  타입 정의

rendered

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

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

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

• FunnelChartRenderResult

  타입 정의

• FunnelChartEngineTier

  타입 정의

sectionClick

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

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

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

• FunnelChartPointerEventDetail

  타입 정의

sectionHover

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

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

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

• FunnelChartPointerEventDetail

  타입 정의

pointContextMenu

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

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

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

• ChartPointContextMenuEventDetail

  타입 정의

• FunnelChartPointerEventDetail

  타입 정의

tooltipShow

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

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

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

• FunnelChartTooltipShowEventDetail

  타입 정의

tooltipHide

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

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

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

tooltipAction

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

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

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

• FunnelChartTooltipActionEventDetail

  타입 정의

legendItemClick

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

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

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

sectionToggled

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

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

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

appended

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

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

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

windowSlid

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

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

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

chartAnimationStart

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

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

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

chartAnimationEnd

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

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

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

chartAnimationInterrupted

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

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

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

redraw

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

redraw(): Promise<FunnelChartRenderResult>

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

• FunnelChartRenderResult

  타입 정의

getActiveTier

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

getActiveTier(): Promise<FunnelChartEngineTier>

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

• FunnelChartEngineTier

  타입 정의

setData

Replace the bar set.

setData(data: FunnelChartData): Promise<void>

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

• FunnelChartData

  타입 정의

addSection

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

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

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

• FunnelSectionSpec

  타입 정의

removeSection

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

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

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

updateSection

Funnel / pyramid-only — patch a section.

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

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

• FunnelSectionSpec

  타입 정의

appendPoint

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

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

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

• FunnelSectionSpec

  타입 정의

appendBatch

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

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

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

• FunnelSectionSpec

  타입 정의

shift

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

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

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

replace

Swap the streamed set (replace([]) clears it); the base values never leave. Without chart.streaming the dies upsert into the base like a batch (quietly: no appended, no binChanged, as a ring replace).

replace(sections: ReadonlyArray<FunnelSectionSpec | number>): Promise<void>

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

• FunnelSectionSpec

  타입 정의

getStreamSource

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

getStreamSource(): Promise<FunnelChartStreamSource | undefined>

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

• FunnelChartStreamSource

  타입 정의

setAnimation

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

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

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

• FunnelChartEasing

  타입 정의

• FunnelChartAnimationType

  타입 정의

pauseAnimation

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

pauseAnimation(): Promise<void>

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

resumeAnimation

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

resumeAnimation(): Promise<void>

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

replayAnimation

Replay the initial sweep from min → value(s). No-op when animation is off / reduced.

replayAnimation(): Promise<void>

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

hitTest

The box under a host-local CSS point (the nearest slot, within half a pitch), or null.

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

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

• FunnelChartPointerEventDetail

  타입 정의

showTooltipAt

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

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

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

• FunnelChartPointerEventDetail

  타입 정의

hideTooltip

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

hideTooltip(): Promise<void>

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

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.

getEngineStatus(): Promise<ChartEngineStatus>

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

• ChartEngineStatus

  타입 정의