Pyramid

data

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

• FunnelChartData

  Type definition

width

Chart width in pixels. If the container width changes, update width from a ResizeObserver.

height

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

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.

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

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.

reversed

Set true to form a pyramid.

neckWidth

Set to 0.

neckHeight

Set to 0.

gap

Vertical gap between sections (px).

color

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

colors

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

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

labelPlacement

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

• FunnelLabelPlacement

  Type definition

labelColor

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

insideLabelColor

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

labelFontSize

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

showValue

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

showPercent

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

valueFormat

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

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

leaderColor

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

chartTitle

The title inside the chart. Explain the data's unit and meaning alongside it.

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

chartSubtitle

The subtitle inside the chart.

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

tooltipShow

Whether to display the built-in tooltip.

tooltipFormat

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

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

• FunnelChartPointerEventDetail

  Type definition

tooltip

Tooltip settings for pointer-driven values, position, and content.

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

• FunnelChartTooltipInput

  Type definition

enableMouseTracking

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

inactiveOtherSections

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

inactiveSectionOpacity

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

activeSectionIndex

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

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

legend

Whether to show a legend for series or items.

legendPosition

Where the legend is positioned.

• FunnelChartLegendPosition

  Type definition

legendItems

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

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

• LegendItem

  Type definition

animated

Whether to animate initial display and data changes.

animationDuration

Animation duration in milliseconds.

animationEasing

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

• FunnelChartEasing

  Type definition

animationType

Allowed values: initial, update. Default: undefined.

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

• FunnelChartAnimationType

  Type definition

streamSource

A stream source for live data. Check the contract for the specific type.

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

• FunnelChartStreamSource

  Type definition

streamWindow

The streaming data range to keep visible.

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

streamMax

The maximum number of streaming data points to retain.

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

engine

Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type.

• FunnelChartEngineMode

  Type definition

proThreshold

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

unavailable

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

• FunnelChartUnavailableBehaviour

  Type definition

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

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

• FunnelChartRenderResult

  Type definition

• FunnelChartEngineTier

  Type definition

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

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

• FunnelChartPointerEventDetail

  Type definition

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

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

• FunnelChartPointerEventDetail

  Type definition

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

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

• ChartPointContextMenuEventDetail

  Type definition

• FunnelChartPointerEventDetail

  Type definition

tooltipShow

Whether to display the built-in tooltip.

Event name: tooltipShow. Names are case-sensitive. Read the payload from detail on CustomEvent<FunnelChartTooltipShowEventDetail>.

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

• FunnelChartTooltipShowEventDetail

  Type definition

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

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

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

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

• FunnelChartTooltipActionEventDetail

  Type definition

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

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

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

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

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

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

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

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

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

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

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

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

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

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

redraw

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

redraw(): Promise<FunnelChartRenderResult>

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

• FunnelChartRenderResult

  Type definition

getActiveTier

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

getActiveTier(): Promise<FunnelChartEngineTier>

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

• FunnelChartEngineTier

  Type definition

setData

Replace the bar set.

setData(data: FunnelChartData): Promise<void>

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

• FunnelChartData

  Type definition

addSection

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

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

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

• FunnelSectionSpec

  Type definition

removeSection

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

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

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

updateSection

Funnel / pyramid-only — patch a section.

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

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

• FunnelSectionSpec

  Type definition

appendPoint

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

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

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

• FunnelSectionSpec

  Type definition

appendBatch

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

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

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

• FunnelSectionSpec

  Type definition

shift

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

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

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

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>

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

• FunnelSectionSpec

  Type definition

getStreamSource

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

getStreamSource(): Promise<FunnelChartStreamSource | undefined>

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

• FunnelChartStreamSource

  Type definition

setAnimation

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

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

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

• FunnelChartEasing

  Type definition

• FunnelChartAnimationType

  Type definition

pauseAnimation

Pause the current animation.

pauseAnimation(): Promise<void>

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

resumeAnimation

Resume a paused animation.

resumeAnimation(): Promise<void>

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

replayAnimation

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

replayAnimation(): Promise<void>

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

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>

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

• FunnelChartPointerEventDetail

  Type definition

showTooltipAt

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

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

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

• FunnelChartPointerEventDetail

  Type definition

hideTooltip

Close the currently visible tooltip.

hideTooltip(): Promise<void>

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

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>

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

• ChartEngineStatus

  Type definition