Lollipop.
COMMUNITYCompare category values with simple dots and stems.
LIVE EXAMPLE
Category ranking
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
<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
| Property | Input format |
|---|---|
values | A number array for the categories. |
categories | Category names in value order. |
orientation | vertical 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.
Feature examples
#Try 21 interactive feature examples and inspect their code. Select “Edit in preview” to combine more options in the settings panel above.
Marker shape
Apply diamond markers and thick stems.
View code
Sort descending
Read rankings sorted from largest to smallest, regardless of input order.
View code
Inspect values with the pointer
Point to data to view the value at that location.
View code
Crosshair tracking
Move the pointer to read horizontal and vertical coordinates alongside values.
View code
Replay animation
Redraw the same example to inspect its initial display animation.
View code
Animation
Compare 1 examples of Animation. Buttons and options update both the live result and source code.
View code
Color
Compare 2 examples of Color. Buttons and options update both the live result and source code.
View code
Crosshair
Compare 4 examples of Crosshair. Buttons and options update both the live result and source code.
View code
Markers
Compare 1 examples of Markers. Buttons and options update both the live result and source code.
View code
Null Values
Compare 1 examples of Null Values. Buttons and options update both the live result and source code.
View code
Orientation
Compare 2 examples of Orientation. Buttons and options update both the live result and source code.
View code
Large datasets
Compare 2 examples of Large datasets. Buttons and options update both the live result and source code.
View code
Size
Compare 2 examples of Size. Buttons and options update both the live result and source code.
View code
Appearance and style
Compare 1 examples of Appearance and style. Buttons and options update both the live result and source code.
View code
Tooltip
Compare 12 examples of Tooltip. Buttons and options update both the live result and source code.
View code
Data input
Compare 2 examples of Data input. Buttons and options update both the live result and source code.
View code
Context menu
Compare 1 examples of Context menu. Buttons and options update both the live result and source code.
View code
Data context menu
Compare 1 examples of Data context menu. Buttons and options update both the live result and source code.
View code
Runtime API
Compare 1 examples of Runtime API. Buttons and options update both the live result and source code.
View code
Overview
Compare 1 examples of Overview. Buttons and options update both the live result and source code.
View code
Streaming · Add and update live dataPRO
Compare 1 examples of Add and update live data. Buttons and options update both the live result and source code.
View code
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.
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 / Property | Type / Default | Description |
|---|---|---|
LollipopChartValuesDefault: new Float32Array(0) | A number array for the categories. | |
ReadonlyArray<string>Default: undefined | Category names in value order. | |
numberDefault: 640 | Chart width in pixels. Update with ResizeObserver when the container changes. | |
numberDefault: 360 | Chart height in pixels. | |
| brandLogo | stringDefault: undefined | The 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. |
| lineWidth | numberDefault: 2 | Stem width in CSS px. |
LollipopMarkerSymbolDefault: 'circle' | Marker glyph. | |
| markerSize | numberDefault: 6 | Marker radius in CSS px. |
numberDefault: 0 | Value the stems grow from. Default 0. | |
| sortDescending | booleanDefault: false | Sort categories by value, largest first. Default false (source order). |
LollipopOrientationDefault: 'horizontal' | vertical or horizontal. | |
| xLabelMode | 'auto' | 'all' | 'thin' | 'rotate' | 'none'Default: undefined | How crowded category-axis labels are decluttered. Default 'auto' thins labels horizontally. |
| xLabelRotation | numberDefault: undefined | Explicit category-label rotation in degrees (respected as a floor). |
| valueAxisLabel | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
| xAxis | CartesianAxisInput | ReadonlyArray<CartesianAxisInput>Default: undefined | Allowed values: auto, off. Default: undefined. |
| yAxis | CartesianAxisInputDefault: undefined | Allowed values: auto, off. Default: undefined. |
| gridLines | CartesianGridLinesInputDefault: undefined | Allowed values: auto, off. Default: undefined. |
CartesianCrosshairInputDefault: undefined | Crosshair that follows the cursor across the plot. `true`/`'auto'` enables a snapping line; pass an object to set mode/snap/color/dash. | |
| chartTitle | stringDefault: undefined | The title inside the chart. Explain the data's unit and meaning alongside it. |
| chartSubtitle | stringDefault: undefined | The subtitle inside the chart. |
| tooltipEnabled | booleanDefault: true | Set as an HTML attribute or JavaScript property. type: boolean. |
CartesianTooltipInputDefault: undefined | Tooltip settings for pointer-driven values, position, and content. | |
| animated | booleanDefault: false | Whether to animate initial display and data changes. |
| animationDuration | numberDefault: 600 | Animation duration in milliseconds. |
| animationEasing | LollipopChartEasingDefault: 'ease-out' | Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'. |
| animationType | LollipopChartAnimationTypeDefault: undefined | Allowed values: initial, update. Default: undefined. |
Other properties 11
| Attribute / Property | Type / Default | Description |
|---|---|---|
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). | |
| markerColor | stringDefault: undefined | Marker fill override (defaults to `color`). |
| xLabelMaxCount | numberDefault: undefined | Hard cap on the number of category labels shown. |
| tooltipFormat | (detail: LollipopChartPointerEventDetail) => stringDefault: undefined | Pass as a JavaScript property. type: (detail: LollipopChartPointerEventDetail) => string. |
| enableMouseTracking | booleanDefault: true | Set as an HTML attribute or JavaScript property. type: boolean. |
| streamSource | LollipopChartStreamSourceDefault: undefined | A stream source for live data. Check the contract for the specific type. |
| streamWindow | numberDefault: undefined | The streaming data range to keep visible. |
| streamMax | numberDefault: undefined | The 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. | |
| proThreshold | numberDefault: 50_000 | Set as an HTML attribute or JavaScript property. type: number. |
LollipopChartUnavailableBehaviourDefault: 'fallback' | Allowed values: fallback, error, throw. Default: 'fallback'. |
Events 14
| Events | Detail type | Description |
|---|---|---|
LollipopChartRenderResult & { tier: LollipopChartEngineTier } | Emits rendering results in detail when chart drawing completes. | |
LollipopChartPointerEventDetail | A point selection event. Read the selected data and index from CustomEvent.detail. | |
LollipopChartPointerEventDetail | null | CustomEvent.detail type: LollipopChartPointerEventDetail | null. Event names are case-sensitive. | |
CartesianCrosshairEventDetail | null | CustomEvent.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. | |
void | CustomEvent.detail type: void. Event names are case-sensitive. | |
void | CustomEvent.detail type: void. Event names are case-sensitive. | |
void | CustomEvent.detail type: void. Event names are case-sensitive. | |
CartesianTooltipEventDetail | Whether to display the built-in tooltip. | |
void | CustomEvent.detail type: void. Event names are case-sensitive. | |
CartesianTooltipActionEventDetail | CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive. | |
CartesianSeriesOutsideClickEventDetail | CustomEvent.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 / Arguments | Return type | Description |
|---|---|---|
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: LollipopChartValues | Promise<void> | An asynchronous method. Check the argument and return types below. |
| datum: LollipopBarDatum | number | Promise<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: number | Promise<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: number | Promise<LollipopChartPointerEventDetail | null> | An asynchronous method. Check the argument and return types below. |
| index: number | Promise<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. |
No matching APIs.