Item.

COMMUNITY

Show counts with repeated symbols.

Live preview17 feature examples

LIVE EXAMPLE

Seat composition

Match the page theme
Interact with the chart to see selection and range-change results here.
OptionsChanges are reflected in the preview and code.
Appearance and style9
Legend and interaction12
Title and dimensions3

Represent one unit with one symbol. All values are sample data.

View code
Current preview
<div id="chart-container" style="width: 100%; min-width: 0;"></div>

<script type="module">
  import { defineCustomElement as define0 } from '@syidax/advanced/components/sy-item-chart.js';
  define0();

  const specs = [
    {
      "id": "example-chart",
      "tag": "sy-item-chart",
      "props": {
        "engine": "standard",
        "values": [
          {
            "name": "Product A",
            "value": 42,
            "color": "#8263d9"
          },
          {
            "name": "Product B",
            "value": 28,
            "color": "#239c91"
          },
          {
            "name": "Product C",
            "value": 18,
            "color": "#e99954"
          },
          {
            "name": "Other",
            "value": 12,
            "color": "#d76c8f"
          }
        ],
        "legend": 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', 'item example chart');
    return element;
  });
  container.replaceChildren(...elements);
  const chart = elements.at(-1);
  const onEvent = event => {
    console.log('pointClick', event.detail);
  };
  chart.addEventListener('pointClick', 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('pointClick', onEvent);
    container.replaceChildren();
  }
</script>

Usage and data

#

Represent whole-number counts such as seats, people, or individual items.

Not suitable for precise fractional comparisons. Explain what each symbol represents.

Data contract

PropertyInput format
valuesAn array of { name, value, color? }. value is the symbol count.
symbolcircle, square, or diamond.

Updating data

Assign a new array or object to the property instead of mutating values inside an array. Chart events provide selection results through event.detail. When disposing of the view, clean up ResizeObserver and event listeners registered by your app.

Add to your interface

#

The code tabs below the preview contain the full data, options, event bindings, and responsive sizing for the current example. Copy them into an app project, such as Vite, that can resolve the installed packages.

Shared sy-chart API versus direct tags

API reference

#

The full public API for sy-item-chart. Pass objects and arrays as JavaScript properties. Select a name to view usage code and type definitions.

Key properties

Attribute / PropertyType / DefaultDescription
ItemChartValuesDefault: []An array of { name, value, color? }. value is the symbol count.
numberDefault: 520Chart width in pixels. Update with ResizeObserver when the container changes.
numberDefault: 400Chart height in pixels.
brandLogostringDefault: undefinedThe default is the Syidax logo. With the Pro chart.branding entitlement, use none or a PNG, JPEG, or WebP data URL.
brandPosition'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'Default: 'bottom-right'The corner where the logo is anchored. Applies equally to Community and Pro, on screen and in image exports.
ItemChartSymbolDefault: 'circle'circle, square, or diamond.
numberDefault: undefinedExplicit concentric ring count; auto (smallest that fits) when unset.
itemPaddingnumberDefault: 0.10..0.9 — fraction of each cell kept as whitespace around its dot (Highcharts itemPadding).
startAnglenumberDefault: -100Degrees, 0 = 12 o'clock, clockwise. Default −100…100 = parliament hemicycle.
endAnglenumberDefault: 100Set as an HTML attribute or JavaScript property. type: number.
centerTextstringDefault: undefinedSet as an HTML attribute or JavaScript property. type: string.
centerSubtextstringDefault: undefinedSet as an HTML attribute or JavaScript property. type: string.
chartTitlestringDefault: undefinedThe title inside the chart. Explain the data's unit and meaning alongside it.
chartSubtitlestringDefault: undefinedThe subtitle inside the chart.
booleanDefault: falseWhether to show a legend for series or items.
legendPositionItemChartLegendPositionDefault: 'bottom'Where the legend is positioned.
tooltipShowbooleanDefault: trueWhether to display the built-in tooltip.
ItemChartTooltipInputDefault: undefinedTooltip settings for pointer-driven values, position, and content.
CartesianZoomInputDefault: undefinedSettings for zooming and the visible range.
animatedbooleanDefault: falseWhether to animate initial display and data changes.
animationDurationnumberDefault: 600Animation duration in milliseconds.
animationEasingItemChartEasingDefault: 'ease-out'Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'.
animationTypeItemChartAnimationTypeDefault: undefinedAllowed values: initial, update. Default: undefined.
Other properties 18
Attribute / PropertyType / DefaultDescription
ItemChartPaletteNameDefault: 'tableau10'Allowed values: tableau10, tableau20, observable10, paired12, set3_12. Default: 'tableau10'.
ReadonlyArray<string>Default: undefinedPass as a JavaScript property. type: ReadonlyArray<string>.
innerSizenumber | stringDefault: undefinedCentral hole — px or `%` of the outer radius (Highcharts innerSize).
number | stringDefault: undefinedPass as a JavaScript property. type: number | string.
centerXnumber | stringDefault: undefinedPass as a JavaScript property. type: number | string.
centerYnumber | stringDefault: undefinedPass as a JavaScript property. type: number | string.
minSizenumberDefault: 80Set as an HTML attribute or JavaScript property. type: number.
legendItemsLegendItem[]Default: undefinedPass as a JavaScript property. type: LegendItem[].
legendFloatAlign'start' | 'center' | 'end'Default: 'end'`legend-position="float"`: the overlay's horizontal anchor inside the drawing rectangle.
legendFloatVerticalAlign'top' | 'middle' | 'bottom'Default: 'top'`legend-position="float"`: the overlay's vertical anchor inside the drawing rectangle.
legendDraggablebooleanDefault: false`legend-position="float"`: the floating legend can be dragged inside the chart bounds.
tooltipFormat(party: ItemChartResolvedParty) => stringDefault: undefinedPass as a JavaScript property. type: (party: ItemChartResolvedParty) => string.
enableMouseTrackingbooleanDefault: trueSet as an HTML attribute or JavaScript property. type: boolean.
ItemChartEngineModeDefault: 'auto'Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type.
ItemChartUnavailableBehaviourDefault: 'fallback'Allowed values: fallback, error, throw. Default: 'fallback'.
streamSourceItemChartStreamSourceDefault: undefinedA stream source for live data. Check the contract for the specific type.
streamWindownumberDefault: undefinedThe streaming data range to keep visible.
streamMaxnumberDefault: undefinedThe maximum number of streaming data points to retain.
Events 15
EventsDetail typeDescription
ItemChartRenderResult & { tier: ItemChartEngineTier }Emits rendering results in detail when chart drawing completes.
ItemChartPointEventDetailA point selection event. Read the selected data and index from CustomEvent.detail.
ItemChartPointEventDetail | nullCustomEvent.detail type: ItemChartPointEventDetail | null. Event names are case-sensitive.
ChartPointContextMenuEventDetail<ItemChartPointEventDetail>CustomEvent.detail type: ChartPointContextMenuEventDetail<ItemChartPointEventDetail>. Event names are case-sensitive.
{ index: number; partyId: string; label: string; disabled: boolean }CustomEvent.detail type: { index: number; partyId: string; label: string; disabled: boolean }. Event names are case-sensitive.
{ index: number; seriesId: string; disabled: boolean }CustomEvent.detail type: { index: number; seriesId: string; disabled: boolean }. Event names are case-sensitive.
{ count: number }CustomEvent.detail type: { count: number }. Event names are case-sensitive.
{ dropped: number }CustomEvent.detail type: { dropped: number }. Event names are case-sensitive.
voidCustomEvent.detail type: void. Event names are case-sensitive.
voidCustomEvent.detail type: void. Event names are case-sensitive.
voidCustomEvent.detail type: void. Event names are case-sensitive.
ItemChartTooltipShowEventDetailWhether to display the built-in tooltip.
voidCustomEvent.detail type: void. Event names are case-sensitive.
ItemChartTooltipActionEventDetailCustomEvent.detail type: ItemChartTooltipActionEventDetail. Event names are case-sensitive.
CartesianZoomChangeEventDetailFired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new viewport windows.
Methods 25

Stencil methods return Promises. Use await within an async function to read the result.

Method / ArgumentsReturn typeDescription
Promise<ItemChartRenderResult>An asynchronous method. Check the argument and return types below.
Promise<ItemChartEngineTier>An asynchronous method. Check the argument and return types below.
datum: ItemChartDatum, opts?: { insertAt?: number }Promise<number>An asynchronous method. Check the argument and return types below.
idOrIndex: string | numberPromise<boolean>An asynchronous method. Check the argument and return types below.
idOrIndex: string | number, patch: Partial<Exclude<ItemChartDatum, number>>Promise<boolean>An asynchronous method. Check the argument and return types below.
idOrIndex: string | number, value: numberPromise<boolean>An asynchronous method. Check the argument and return types below.
datum: ItemChartDatumPromise<void>An asynchronous method. Check the argument and return types below.
datums: ReadonlyArray<ItemChartDatum>Promise<void>An asynchronous method. Check the argument and return types below.
count?: numberPromise<void>An asynchronous method. Check the argument and return types below.
datums: ReadonlyArray<ItemChartDatum>Promise<void>An asynchronous method. Check the argument and return types below.
Promise<ItemChartStreamSource | undefined>An asynchronous method. Check the argument and return types below.
options: { duration?: number; easing?: ItemChartEasing; enabled?: boolean; type?: ItemChartAnimationType }Promise<void>An asynchronous method. Check the argument and return types below.
Promise<void>An asynchronous method. Check the argument and return types below.
Promise<void>An asynchronous method. Check the argument and return types below.
Promise<void>Replay the initial angular-wipe reveal. No-op when animation is off.
cssX: number, cssY: numberPromise<{ partyIndex: number; partyId: string; seatIndex: number; seatInParty: number } | null>An asynchronous method. Check the argument and return types below.
idOrIndex: string | numberPromise<ItemChartPointEventDetail | null>An asynchronous method. Check the argument and return types below.
Promise<void>An asynchronous method. Check the argument and return types below.
request: CartesianZoomRequestPromise<CartesianZoomChangeEventDetail | null>Zoom to explicit viewport windows: `x` / `y` as `{ min, max }` or `[min, max]` over 0..1 (`null` clears that orientation).
factor: number, anchorFraction?: numberPromise<CartesianZoomChangeEventDetail | null>Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre).
delta: { x?: number; y?: number }Promise<CartesianZoomChangeEventDetail | null>Slide the zoomed windows by viewport units (`{ x?, y? }`, 1 = the whole drawing); a no-op at the full extent.
Promise<CartesianZoomChangeEventDetail | null>Back to the full extent.
Promise<CartesianZoomState | null>The current zoom state (`null` = full extent).
request?: CartesianZoomExtentRequestPromise<CartesianZoomExtentDetail | null>The full extent (0..1 on both orientations, key `'0'`).
Promise<ChartEngineStatus>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.