Dot Plot.
COMMUNITYCompare multiple measurements per category using dots.
LIVE EXAMPLE
Measurements by group
Appearance and style3
Axes and grid lines5
Legend and interaction14
Title and dimensions3
Show multiple values for each item on a shared horizontal scale. 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-dot-plot-chart.js';
define0();
const specs = [
{
"id": "example-chart",
"tag": "sy-dot-plot-chart",
"props": {
"engine": "standard",
"groups": ["Reference", "Target", "Actual"],
"legend": true,
"data": [
{
"category": "A",
"values": [25, 45, 62]
},
{
"category": "B",
"values": [38, 55, 70]
},
{
"category": "C",
"values": [30, 50, 82]
}
],
"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', 'dot-plot 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 read differences between groups on the same scale.
Dots overlap at identical positions. Limit the number of groups and explain the colors and legend.
Data contract
| Property | Input format |
|---|---|
data | An array of { category, values: [...] }. Each index represents the same group. |
groups | Group names corresponding to values indices. Match the group count to each values array's length. |
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 23 interactive feature examples and inspect their code. Select “Edit in preview” to combine more options in the settings panel above.
Row guides
Use horizontal guides to compare multiple points for the same item.
View code
Sort items
Sort descending to inspect larger values first.
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 3 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
Legend
Compare 4 examples of Legend. Buttons and options update both the live result and source code.
View code
Markers
Compare 2 examples of Markers. Buttons and options update both the live result and source code.
View code
Large datasets
Compare 1 examples of Large datasets. Buttons and options update both the live result and source code.
View code
Row lines
Compare 2 examples of Row lines. Buttons and options update both the live result and source code.
View code
Data input
Compare 3 examples of Data input. Buttons and options update both the live result and source code.
View code
Size
Compare 1 examples of Size. Buttons and options update both the live result and source code.
View code
Sorting
Compare 2 examples of Sorting. 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-dot-plot-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 |
|---|---|---|
ReadonlyArray<DotPlotDatum>Default: [] | An array of { category, values: [...] }. Each index represents the same group. | |
ReadonlyArray<string>Default: [] | Group names corresponding to values indices. Match the group count to each values array's length. | |
numberDefault: 640 | Chart width in pixels. Update with ResizeObserver when the container changes. | |
numberDefault: 380 | 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. |
| markerSize | numberDefault: 6 | Marker radius in CSS px. |
| showRowLines | booleanDefault: true | Draw a faint guide line across each row between its min and max dot. |
| sortDescending | booleanDefault: false | Sort categories by the first series' value, largest first. |
| xLabelMode | 'auto' | 'all' | 'thin' | 'rotate' | 'none'Default: undefined | How crowded category-axis (Y/row) 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. |
| 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. |
booleanDefault: true | Whether to show a legend for series or items. | |
| legendPosition | DotPlotChartLegendPositionDefault: 'top' | Where the legend is positioned. |
| 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 | DotPlotChartEasingDefault: 'ease-out' | Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'. |
| animationType | DotPlotChartAnimationTypeDefault: undefined | Allowed values: initial, update. Default: undefined. |
Other properties 12
| Attribute / Property | Type / Default | Description |
|---|---|---|
ReadonlyArray<string>Default: undefined | Optional override for category (row) labels; else derived from `data`. | |
string | ReadonlyArray<string>Default: '' | Group colour(s). Polymorphic: a single CSS colour, an array of colours, or a comma-separated string. Resolved once per render to one colour per group (`['#94a3b8', '#2563eb']` defaults, then the tableau palette). A datum's own `colors[gi]` overrides the resolved group colour for that dot. | |
DotPlotMarkerSymbol | string | ReadonlyArray<string>Default: 'circle' | Marker glyph(s). Polymorphic exactly like `color`: a single symbol, an array of symbols, or a comma-separated string. Resolved once per render to one marker per group (`['circle', ...]` default). A datum's own `markers[gi]` overrides the resolved group marker for that dot. | |
| xLabelMaxCount | numberDefault: undefined | Hard cap on the number of category labels shown. |
| tooltipFormat | (detail: DotPlotChartPointerEventDetail) => stringDefault: undefined | Pass as a JavaScript property. type: (detail: DotPlotChartPointerEventDetail) => string. |
| enableMouseTracking | booleanDefault: true | Set as an HTML attribute or JavaScript property. type: boolean. |
| streamSource | DotPlotChartStreamSourceDefault: 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. |
DotPlotChartEngineModeDefault: '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. |
DotPlotChartUnavailableBehaviourDefault: 'fallback' | Allowed values: fallback, error, throw. Default: 'fallback'. |
Events 16
| Events | Detail type | Description |
|---|---|---|
DotPlotChartRenderResult & { tier: DotPlotChartEngineTier } | Emits rendering results in detail when chart drawing completes. | |
DotPlotChartPointerEventDetail | A point selection event. Read the selected data and index from CustomEvent.detail. | |
DotPlotChartPointerEventDetail | null | CustomEvent.detail type: DotPlotChartPointerEventDetail | null. Event names are case-sensitive. | |
CartesianCrosshairEventDetail | null | CustomEvent.detail type: CartesianCrosshairEventDetail | null. 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. | |
ChartPointContextMenuEventDetail<DotPlotChartPointerEventDetail> | CustomEvent.detail type: ChartPointContextMenuEventDetail<DotPlotChartPointerEventDetail>. Event names are case-sensitive. | |
DotPlotChartLegendItemEventDetail | CustomEvent.detail type: DotPlotChartLegendItemEventDetail. Event names are case-sensitive. | |
DotPlotChartSeriesToggledEventDetail | CustomEvent.detail type: DotPlotChartSeriesToggledEventDetail. 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. |
Methods 18
Stencil methods return Promises. Use await within an async function to read the result.
| Method / Arguments | Return type | Description |
|---|---|---|
Promise<DotPlotChartRenderResult> | An asynchronous method. Check the argument and return types below. | |
Promise<DotPlotChartEngineTier> | An asynchronous method. Check the argument and return types below. | |
| data: ReadonlyArray<DotPlotDatum> | Promise<void> | An asynchronous method. Check the argument and return types below. |
| datum: DotPlotDatum | Promise<void> | An asynchronous method. Check the argument and return types below. |
| data: ReadonlyArray<DotPlotDatum> | 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<DotPlotDatum> | Promise<void> | An asynchronous method. Check the argument and return types below. |
Promise<DotPlotChartStreamSource | undefined> | An asynchronous method. Check the argument and return types below. | |
| options: { duration?: number; easing?: DotPlotChartEasing; enabled?: boolean; type?: DotPlotChartAnimationType } | 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<DotPlotChartPointerEventDetail | null> | An asynchronous method. Check the argument and return types below. |
| pointIndex: number, seriesIndex?: number | Promise<CartesianTooltipEventDetail | null> | Open the tooltip for a dot programmatically. `pointIndex` is the category (row) index; the optional `seriesIndex` selects a group within that row (defaults to the first visible group's dot in the row). Returns the emitted tooltip detail, or null when no dot resolves / the tooltip is disabled. |
Promise<void> | An asynchronous method. Check the argument and return types below. | |
| id: string | number, opts?: { redraw?: boolean } | Promise<boolean> | An asynchronous method. Check the argument and return types below. |
| id: string | number, opts?: { redraw?: boolean } | Promise<boolean> | 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.