Lollipop.

COMMUNITY

Compare category values with simple dots and stems.

Live preview21 feature examples

LIVE EXAMPLE

Category ranking

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 style6
Axes and grid lines17
Legend and interaction12
Title and dimensions3

Compare magnitudes with stems and dots instead of bars. 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-lollipop-chart.js';
  define0();

  const specs = [
    {
      "id": "example-chart",
      "tag": "sy-lollipop-chart",
      "props": {
        "engine": "standard",
        "values": [42, 28, 18, 12],
        "categories": ["A", "B", "C", "D"],
        "orientation": "vertical",
        "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', 'lollipop 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 to emphasize rankings or differences across a modest number of categories.

Small dots can be difficult to click. Provide tooltips and a data table.

Data contract

PropertyInput format
valuesA number array for the categories.
categoriesCategory names in value order.
orientationvertical or horizontal.

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-lollipop-chart. Pass objects and arrays as JavaScript properties. Select a name to view usage code and type definitions.

Key properties

Attribute / PropertyType / DefaultDescription
LollipopChartValuesDefault: new Float32Array(0)A number array for the categories.
ReadonlyArray<string>Default: undefinedCategory names in value order.
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.
lineWidthnumberDefault: 2Stem width in CSS px.
LollipopMarkerSymbolDefault: 'circle'Marker glyph.
markerSizenumberDefault: 6Marker radius in CSS px.
numberDefault: 0Value the stems grow from. Default 0.
sortDescendingbooleanDefault: falseSort categories by value, largest first. Default false (source order).
LollipopOrientationDefault: 'horizontal'vertical or horizontal.
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: undefinedAllowed values: auto, off. Default: undefined.
yAxisCartesianAxisInputDefault: undefinedAllowed values: auto, off. Default: undefined.
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.
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.
animationEasingLollipopChartEasingDefault: 'ease-out'Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'.
animationTypeLollipopChartAnimationTypeDefault: undefinedAllowed values: initial, update. Default: undefined.
Other properties 11
Attribute / PropertyType / DefaultDescription
string | ReadonlyArray<string>Default: '#2563eb'Stem + marker colour. Accepts a single CSS colour, an array, or a comma-separated string (the first colour is used).
markerColorstringDefault: undefinedMarker fill override (defaults to `color`).
xLabelMaxCountnumberDefault: undefinedHard cap on the number of category labels shown.
tooltipFormat(detail: LollipopChartPointerEventDetail) => stringDefault: undefinedPass as a JavaScript property. type: (detail: LollipopChartPointerEventDetail) => string.
enableMouseTrackingbooleanDefault: trueSet as an HTML attribute or JavaScript property. type: boolean.
streamSourceLollipopChartStreamSourceDefault: 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.
LollipopChartEngineModeDefault: '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.
LollipopChartUnavailableBehaviourDefault: 'fallback'Allowed values: fallback, error, throw. Default: 'fallback'.
Events 14
EventsDetail typeDescription
LollipopChartRenderResult & { tier: LollipopChartEngineTier }Emits rendering results in detail when chart drawing completes.
LollipopChartPointerEventDetailA point selection event. Read the selected data and index from CustomEvent.detail.
LollipopChartPointerEventDetail | nullCustomEvent.detail type: LollipopChartPointerEventDetail | null. Event names are case-sensitive.
CartesianCrosshairEventDetail | nullCustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive.
ChartPointContextMenuEventDetail<LollipopChartPointerEventDetail>CustomEvent.detail type: ChartPointContextMenuEventDetail<LollipopChartPointerEventDetail>. 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.
Methods 16

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

Method / ArgumentsReturn typeDescription
Promise<LollipopChartRenderResult>An asynchronous method. Check the argument and return types below.
Promise<LollipopChartEngineTier>An asynchronous method. Check the argument and return types below.
values: LollipopChartValuesPromise<void>An asynchronous method. Check the argument and return types below.
datum: LollipopBarDatum | numberPromise<void>An asynchronous method. Check the argument and return types below.
data: ReadonlyArray<LollipopBarDatum | 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<LollipopBarDatum | number>Promise<void>An asynchronous method. Check the argument and return types below.
Promise<LollipopChartStreamSource | undefined>An asynchronous method. Check the argument and return types below.
options: { duration?: number; easing?: LollipopChartEasing; enabled?: boolean; type?: LollipopChartAnimationType }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<LollipopChartPointerEventDetail | 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.
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.