Pictorial.

COMMUNITY

Express state through the filled portion of a familiar shape.

Live preview19 feature examples

LIVE EXAMPLE

Completion status

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 style2
Axes and grid lines17
Legend and interaction13
Title and dimensions3

Fill image areas with values on a shared scale. 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-pictorial-chart.js';
  define0();

  const specs = [
    {
      "id": "example-chart",
      "tag": "sy-pictorial-chart",
      "props": {
        "engine": "standard",
        "values": [65, 80, 45],
        "categories": ["A", "B", "C"],
        "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', 'pictorial 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

#

Use in dashboards and infographics explaining a small number of metrics.

Readers may confuse area with height. Include numeric values and units.

Data contract

PropertyInput format
valuesNumeric values for each item.
categoriesCategory names for the shapes.

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.

Feature examples

#

Try 19 interactive feature examples and inspect their code. Select “Edit in preview” to combine more options in the settings panel above.

Full-capacity background

Contrast the icon's full area with the filled amount.

Interact with the chart to see results here.
View code

Icon spacing

Reduce icon spacing for a denser display.

Interact with the chart to see results here.
View code

Inspect values with the pointer

Point to data to view the value at that location.

Interact with the chart to see results here.
View code

Crosshair tracking

Move the pointer to read horizontal and vertical coordinates alongside values.

Interact with the chart to see results here.
View code

Drag to zoom and pan

Drag to zoom and hold Shift to pan. Use Ctrl + wheel to zoom in or out.

Interact with the chart to see results here.
View code

Replay animation

Redraw the same example to inspect its initial display animation.

Interact with the chart to see results here.
View code

Animation

Compare 1 examples of Animation. Buttons and options update both the live result and source code.

Interact with the chart to see results here.
View code

Axis

Compare 7 examples of Axis. Buttons and options update both the live result and source code.

Interact with the chart to see results here.
View code

Crosshair

Compare 5 examples of Crosshair. Buttons and options update both the live result and source code.

Interact with the chart to see results here.
View code

Large datasets

Compare 1 examples of Large datasets. Buttons and options update both the live result and source code.

Interact with the chart to see results here.
View code

Size

Compare 1 examples of Size. Buttons and options update both the live result and source code.

Interact with the chart to see results here.
View code

Tooltip

Compare 12 examples of Tooltip. Buttons and options update both the live result and source code.

Interact with the chart to see results here.
View code

Data input

Compare 1 examples of Data input. Buttons and options update both the live result and source code.

Interact with the chart to see results here.
View code

Zoom and pan

Compare 6 examples of Zoom and pan. Buttons and options update both the live result and source code.

Interact with the chart to see results here.
View code

Context menu

Compare 1 examples of Context menu. Buttons and options update both the live result and source code.

Interact with the chart to see results here.
View code

Data context menu

Compare 1 examples of Data context menu. Buttons and options update both the live result and source code.

Interact with the chart to see results here.
View code

Read coordinates and data

Compare 1 examples of Read coordinates and data. Buttons and options update both the live result and source code.

Interact with the chart to see results here.
View code

Overview

Compare 3 examples of Overview. Buttons and options update both the live result and source code.

Interact with the chart to see results here.
View code

Streaming · Add and update live dataPRO

Compare 3 examples of Add and update live data. Buttons and options update both the live result and source code.

Interact with the chart to see results here.
View code

API reference

#

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

Key properties

Attribute / PropertyType / DefaultDescription
PictorialChartValuesDefault: new Float32Array(0)Numeric values for each item.
ReadonlyArray<string>Default: undefinedCategory names for the shapes.
numberDefault: 640Chart width in pixels. Update with ResizeObserver when the container changes.
numberDefault: 360Chart 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.
iconPaddingnumberDefault: 0.1Fraction of each band kept as whitespace around its icon, 0..0.9.
trackOpacitynumberDefault: 0.16Opacity of the unfilled remainder silhouette (0 hides the track).
xLabelMode'auto' | 'all' | 'thin' | 'rotate' | 'none'Default: undefinedHow crowded category-axis labels are decluttered. Default 'auto' thins labels horizontally.
xLabelRotationnumberDefault: undefinedExplicit category-label rotation in degrees (respected as a floor).
valueAxisLabelstringDefault: undefinedSet as an HTML attribute or JavaScript property. type: string.
xAxisCartesianAxisInput | ReadonlyArray<CartesianAxisInput>Default: undefinedThe category axis, or slot array — slot 0 is the category axis (its `show` / `label` / `position` / `format` apply); later slots are linked relabels or their own kinds.
yAxisCartesianAxisInput | ReadonlyArray<CartesianAxisInput>Default: undefinedThe value axis, or slot array — slot 0 (left) carries `value-axis-label` unless it names its own; a user `kind: 'log'` wins; later slots relabel (linked) or bring their own min / max.
gridLinesCartesianGridLinesInputDefault: undefinedAllowed values: auto, off. Default: undefined.
CartesianCrosshairInputDefault: undefinedCrosshair that follows the cursor across the plot. `true`/`'auto'` enables a snapping line; pass an object to set mode/snap/color/dash.
CartesianZoomInputDefault: undefinedSettings for zooming and the visible range.
chartTitlestringDefault: undefinedThe title inside the chart. Explain the data's unit and meaning alongside it.
chartSubtitlestringDefault: undefinedThe subtitle inside the chart.
tooltipEnabledbooleanDefault: trueSet as an HTML attribute or JavaScript property. type: boolean.
CartesianTooltipInputDefault: undefinedTooltip settings for pointer-driven values, position, and content.
animatedbooleanDefault: falseWhether to animate initial display and data changes.
animationDurationnumberDefault: 600Animation duration in milliseconds.
animationEasingPictorialChartEasingDefault: 'ease-out'Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'.
animationTypePictorialChartAnimationTypeDefault: undefinedAllowed values: initial, update. Default: undefined.
Other properties 11
Attribute / PropertyType / DefaultDescription
string | ReadonlyArray<string>Default: '#2563eb'Icon fill colour. Accepts a single CSS colour, an array, or a comma-separated string — one colour applies to every icon; a list cycles per icon.
ReadonlyArray<string>Default: undefinedSVG path definitions the icons cycle through per category (Highcharts `paths`). Property-only. Default: the person silhouette.
xLabelMaxCountnumberDefault: undefinedHard cap on the number of category labels shown.
tooltipFormat(detail: PictorialChartPointerEventDetail) => stringDefault: undefinedPass as a JavaScript property. type: (detail: PictorialChartPointerEventDetail) => string.
enableMouseTrackingbooleanDefault: trueSet as an HTML attribute or JavaScript property. type: boolean.
streamSourcePictorialChartStreamSourceDefault: 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.
PictorialChartEngineModeDefault: 'auto'Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type.
proThresholdnumberDefault: 50_000Set as an HTML attribute or JavaScript property. type: number.
PictorialChartUnavailableBehaviourDefault: 'fallback'Allowed values: fallback, error, throw. Default: 'fallback'.
Events 15
EventsDetail typeDescription
PictorialChartRenderResult & { tier: PictorialChartEngineTier }Emits rendering results in detail when chart drawing completes.
PictorialChartPointerEventDetailA point selection event. Read the selected data and index from CustomEvent.detail.
PictorialChartPointerEventDetail | nullCustomEvent.detail type: PictorialChartPointerEventDetail | null. Event names are case-sensitive.
CartesianCrosshairEventDetail | nullCustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive.
ChartPointContextMenuEventDetail<PictorialChartPointerEventDetail>CustomEvent.detail type: ChartPointContextMenuEventDetail<PictorialChartPointerEventDetail>. 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.
CartesianTooltipEventDetailWhether to display the built-in tooltip.
voidCustomEvent.detail type: void. Event names are case-sensitive.
CartesianTooltipActionEventDetailCustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive.
CartesianSeriesOutsideClickEventDetailCustomEvent.detail type: CartesianSeriesOutsideClickEventDetail. Event names are case-sensitive.
CartesianZoomChangeEventDetailFired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new state.
Methods 22

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

Method / ArgumentsReturn typeDescription
Promise<PictorialChartRenderResult>An asynchronous method. Check the argument and return types below.
Promise<PictorialChartEngineTier>An asynchronous method. Check the argument and return types below.
values: PictorialChartValuesPromise<void>An asynchronous method. Check the argument and return types below.
datum: PictorialBarDatum | numberPromise<void>An asynchronous method. Check the argument and return types below.
data: ReadonlyArray<PictorialBarDatum | number>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.
data: ReadonlyArray<PictorialBarDatum | number>Promise<void>An asynchronous method. Check the argument and return types below.
Promise<PictorialChartStreamSource | undefined>An asynchronous method. Check the argument and return types below.
options: { duration?: number; easing?: PictorialChartEasing; enabled?: boolean; type?: PictorialChartAnimationType }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>An asynchronous method. Check the argument and return types below.
cssX: number, cssY: numberPromise<PictorialChartPointerEventDetail | null>An asynchronous method. Check the argument and return types below.
index: numberPromise<CartesianTooltipEventDetail | 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 windows: `x` / `y` as `{ min, max }` or `[min, max]` (`null` clears that orientation); `xAxis` / `yAxis` name the axis by id or slot index.
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 data units (`{ x?, y? }`); 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 (and key) of the primary — or the named — master axes (`null` before the first layout).
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.